{ "smithy": "2.0", "shapes": { "com.amazonaws.mediatailor#AccessConfiguration": { "type": "structure", "members": { "AccessType": { "target": "com.amazonaws.mediatailor#AccessType", "traits": { "smithy.api#documentation": "
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location.
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:
\u2022 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.
\u2022 The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
\u2022 The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
AUTODETECT_SIGV4 - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.
Before you can use AUTODETECT_SIGV4 with a MediaPackage Version 2 endpoint, you must meet these requirements:
\u2022 You must grant MediaTailor access to your MediaPackage endpoint by granting mediatailor.amazonaws.com principal access in an Origin Access policy on the endpoint.
\u2022 Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.
\u2022 The caller of the API must have mediapackagev2:GetObject IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.
Before you can use AUTODETECT_SIGV4 with an Amazon S3 bucket, you must meet these requirements:
\u2022 You must grant MediaTailor access to your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For more information about configuring access in IAM, see Access management in the IAM User Guide..
\u2022 The mediatailor.amazonaws.com service principal must have permissions to read all top-level manifests referenced by the VodSource packaging configurations.
\u2022 The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
AWS Secrets Manager access token configuration parameters.
" } } }, "traits": { "smithy.api#documentation": "Access configuration parameters.
" } }, "com.amazonaws.mediatailor#AccessType": { "type": "enum", "members": { "S3_SIGV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3_SIGV4" } }, "SECRETS_MANAGER_ACCESS_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECRETS_MANAGER_ACCESS_TOKEN" } }, "AUTODETECT_SIGV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTODETECT_SIGV4" } } } }, "com.amazonaws.mediatailor#AdBreak": { "type": "structure", "members": { "MessageType": { "target": "com.amazonaws.mediatailor#MessageType", "traits": { "smithy.api#documentation": "The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
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.
", "smithy.api#required": {} } }, "Slate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { "smithy.api#documentation": "Ad break slate configuration.
" } }, "SpliceInsertMessage": { "target": "com.amazonaws.mediatailor#SpliceInsertMessage", "traits": { "smithy.api#documentation": "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.
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
" } }, "AdBreakMetadata": { "target": "com.amazonaws.mediatailor#AdBreakMetadataList", "traits": { "smithy.api#documentation": "Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
Ad break configuration parameters.
" } }, "com.amazonaws.mediatailor#AdBreakMetadataList": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#KeyValuePair" } }, "com.amazonaws.mediatailor#AdBreakOpportunities": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#AdBreakOpportunity" }, "traits": { "smithy.api#documentation": "The list of ad break opportunities detected within the VOD source.
" } }, "com.amazonaws.mediatailor#AdBreakOpportunity": { "type": "structure", "members": { "OffsetMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The offset in milliseconds from the start of the VOD source at which an ad marker was detected.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A location at which a zero-duration ad marker was detected in a VOD source manifest.
" } }, "com.amazonaws.mediatailor#AdConditioningConfiguration": { "type": "structure", "members": { "StreamingMediaFileConditioning": { "target": "com.amazonaws.mediatailor#StreamingMediaFileConditioning", "traits": { "smithy.api#documentation": "For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS. TRANSCODE indicates that MediaTailor must transcode the ads. NONE indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow. For more information about ad conditioning see Using preconditioned ads in the Elemental MediaTailor user guide.
The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns.
" } }, "com.amazonaws.mediatailor#AdDecisionServerConfiguration": { "type": "structure", "members": { "HttpRequest": { "target": "com.amazonaws.mediatailor#HttpRequest", "traits": { "smithy.api#documentation": "The HTTP request configuration parameters for the ad decision server.
" } }, "VastResponse": { "target": "com.amazonaws.mediatailor#VastResponse", "traits": { "smithy.api#documentation": "The settings that control how MediaTailor processes VAST responses from the ad decision server.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.mediatailor#AdMarkerPassthrough": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.mediatailor#__boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Enables ad marker passthrough for your configuration.
" } } }, "traits": { "smithy.api#documentation": "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.
An ADS interaction log event type that MediaTailor emits by default and that you can suppress. For descriptions of each event type, see MediaTailor ADS logs description and event types in Elemental MediaTailor User Guide.
" } }, "com.amazonaws.mediatailor#AdsInteractionLog": { "type": "structure", "members": { "PublishOptInEventTypes": { "target": "com.amazonaws.mediatailor#__adsInteractionPublishOptInEventTypesList", "traits": { "smithy.api#documentation": "Indicates that MediaTailor will emit the selected events in the logs for playback sessions that are initialized with this configuration. These events are not emitted by default and must be explicitly opted in. For descriptions of each event type, see MediaTailor ADS logs description and event types in Elemental MediaTailor User Guide.
" } }, "ExcludeEventTypes": { "target": "com.amazonaws.mediatailor#__adsInteractionExcludeEventTypesList", "traits": { "smithy.api#documentation": "Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.mediatailor#AdsInteractionPublishOptInEventType": { "type": "enum", "members": { "RAW_ADS_RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RAW_ADS_RESPONSE" } }, "RAW_ADS_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RAW_ADS_REQUEST" } }, "RAW_BID_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RAW_BID_REQUEST" } }, "RAW_BID_RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RAW_BID_RESPONSE" } }, "PRE_ADS_REQUEST_HOOK_SUMMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_ADS_REQUEST_HOOK_SUMMARY" } }, "PRE_ADS_REQUEST_FUNCTION_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_ADS_REQUEST_FUNCTION_COMPLETED" } }, "POST_ADS_RESPONSE_HOOK_SUMMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST_ADS_RESPONSE_HOOK_SUMMARY" } }, "POST_ADS_RESPONSE_FUNCTION_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST_ADS_RESPONSE_FUNCTION_COMPLETED" } }, "PRE_MANIFEST_INSERTION_HOOK_SUMMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_MANIFEST_INSERTION_HOOK_SUMMARY" } }, "PRE_MANIFEST_INSERTION_FUNCTION_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_MANIFEST_INSERTION_FUNCTION_COMPLETED" } } }, "traits": { "smithy.api#documentation": "An ADS interaction log event type that MediaTailor emits only when you opt in to it. For descriptions of each event type, see MediaTailor ADS logs description and event types in Elemental MediaTailor User Guide.
" } }, "com.amazonaws.mediatailor#AdsPersonalizationConcurrency": { "type": "structure", "members": { "MaxConcurrentAdsRequests": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum number of simultaneous requests that MediaTailor makes to the ad decision server per manifest request. The default is 1.
" } }, "EnableVodVastParallelization": { "target": "com.amazonaws.mediatailor#__boolean", "traits": { "smithy.api#documentation": "Enables parallel processing of ad decision server requests in VOD workflows when the ADS returns VAST responses. The default is false.
" } } }, "traits": { "smithy.api#documentation": "The concurrency settings for ad decision server interactions during ad personalization.
" } }, "com.amazonaws.mediatailor#AdsPersonalizationTimeouts": { "type": "structure", "members": { "AdsRequestTimeoutMilliseconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum time, in milliseconds, that MediaTailor waits for a single ad decision server response during live or VOD playback. The default is 3000.
" } }, "LiveMaximumAdsPersonalizationTimeMilliseconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum total time, in milliseconds, that MediaTailor spends on ad decision server activity for live manifests, including making requests, waiting for responses, and following VAST wrapper redirects. The default is 10000.
" } }, "VodMaximumAdsPersonalizationTimeMilliseconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum total time, in milliseconds, that MediaTailor spends on ad decision server activity for VOD manifests, including making requests, waiting for responses, and following VAST wrapper redirects. The default is 10000.
" } }, "PrefetchAdsRequestTimeoutMilliseconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum time, in milliseconds, that MediaTailor waits for a single ad decision server response during prefetch retrieval. If not set, the value of AdsRequestTimeoutMilliseconds is used.
" } }, "PrefetchMaximumAdsPersonalizationTimeMilliseconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum total time, in milliseconds, that MediaTailor spends on ad decision server activity during prefetch retrieval, including making requests, waiting for responses, and following VAST wrapper redirects.
" } } }, "traits": { "smithy.api#documentation": "The timeout settings for ad decision server interactions during ad personalization.
" } }, "com.amazonaws.mediatailor#Alert": { "type": "structure", "members": { "AlertCode": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The code for the alert. For example, NOT_PROCESSED.
If an alert is generated for a resource, an explanation of the reason for the alert.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp when the alert was last modified.
", "smithy.api#required": {} } }, "RelatedResourceArns": { "target": "com.amazonaws.mediatailor#__listOf__string", "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARNs) related to this alert.
", "smithy.api#required": {} } }, "ResourceArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#required": {} } }, "Category": { "target": "com.amazonaws.mediatailor#AlertCategory", "traits": { "smithy.api#documentation": "The category that MediaTailor assigns to the alert.
" } } }, "traits": { "smithy.api#documentation": "Alert configuration parameters.
" } }, "com.amazonaws.mediatailor#AlertCategory": { "type": "enum", "members": { "SCHEDULING_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCHEDULING_ERROR" } }, "PLAYBACK_WARNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PLAYBACK_WARNING" } }, "INFO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INFO" } } } }, "com.amazonaws.mediatailor#AlternateMedia": { "type": "structure", "members": { "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location for alternateMedia.
" } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the live source for alternateMedia.
" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the VOD source for alternateMedia.
" } }, "ClipRange": { "target": "com.amazonaws.mediatailor#ClipRange" }, "ScheduledStartTimeMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#documentation": "The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
" } }, "AdBreaks": { "target": "com.amazonaws.mediatailor#__listOfAdBreak", "traits": { "smithy.api#documentation": "Ad break configuration parameters defined in AlternateMedia.
" } }, "DurationMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#documentation": "The duration of the alternateMedia in milliseconds.
" } } }, "traits": { "smithy.api#documentation": "A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.
" } }, "com.amazonaws.mediatailor#ApsPublisherId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 36 }, "smithy.api#pattern": "^[a-z0-9-]+$" } }, "com.amazonaws.mediatailor#ApsRegion": { "type": "enum", "members": { "AMERICAS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMERICAS" } }, "EUROPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EUROPE" } }, "ASIA_PACIFIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASIA_PACIFIC" } } }, "traits": { "smithy.api#documentation": "Supported Amazon Publisher Services regions for yield optimization integration. The region selection affects latency and ad inventory availability, so choose the region closest to your primary audience.
" } }, "com.amazonaws.mediatailor#AudienceMedia": { "type": "structure", "members": { "Audience": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Audience defined in AudienceMedia.
" } }, "AlternateMedia": { "target": "com.amazonaws.mediatailor#__listOfAlternateMedia", "traits": { "smithy.api#documentation": "The list of AlternateMedia defined in AudienceMedia.
" } } }, "traits": { "smithy.api#documentation": "An AudienceMedia object contains an Audience and a list of AlternateMedia.
" } }, "com.amazonaws.mediatailor#Audiences": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.mediatailor#AvailMatchingCriteria": { "type": "structure", "members": { "DynamicVariable": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
You can include up to 100 dynamic variables.
", "smithy.api#required": {} } }, "Operator": { "target": "com.amazonaws.mediatailor#Operator", "traits": { "smithy.api#documentation": "For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
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.
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. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.
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.
" } }, "FillPolicy": { "target": "com.amazonaws.mediatailor#FillPolicy", "traits": { "smithy.api#documentation": "Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" } }, "com.amazonaws.mediatailor#AwsServiceRequestConfiguration": { "type": "structure", "members": { "Runtime": { "target": "com.amazonaws.mediatailor#RuntimeType", "traits": { "smithy.api#documentation": "The expression language used to evaluate expressions in the function configuration. The only supported value is JSONata.
A map of output bindings. Each key is a namespaced output path, such as player_params.device_type. Each value is an expression that MediaTailor evaluates at runtime and can reference the response object from the target service. For more information, see JSONata expression reference in the MediaTailor User Guide.
Specifies how the function sends the request to the target service. The value must match what the target service operation requires. Valid values:
GET \u2013 Retrieves data from the target service.
POST \u2013 Submits a request body to the target service.
The maximum time, in milliseconds, that MediaTailor waits for a response from the AWS service. If the call exceeds this timeout, MediaTailor sets the response status code to null and proceeds with output expression evaluation. Valid values: 100 to 2000.
An expression that evaluates to the endpoint URL for the target AWS service API operation. Use {%...%} delimiters for dynamic expressions. The URL must correspond to a valid endpoint for the service specified in TargetService. The maximum length after evaluation is 2,048 characters.
An expression that evaluates to the request body for the AWS service API call. The body must conform to the input format that the target service operation expects. Applies only when the target operation accepts a request body. The maximum size after evaluation is 64 KB.
" } }, "Headers": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound request to the AWS service. Use this to pass any headers required by the target service operation. You can include a maximum of 50 headers.
" } }, "Cache": { "target": "com.amazonaws.mediatailor#HttpRequestCacheConfiguration", "traits": { "smithy.api#documentation": "The optional response-caching configuration for the function. When present, MediaTailor caches the responses that the function receives from the AWS service, within the time-to-live (TTL) bounds that you specify. Omit this configuration to disable response caching.
" } }, "TargetService": { "target": "com.amazonaws.mediatailor#AwsTargetService", "traits": { "smithy.api#documentation": "The AWS service to call. Valid value: elemental-inference (AWS Elemental Inference).
The AWS Region for the target service. Specify a static Region code (for example, us-east-1) or a JSONata expression that resolves to a Region code at runtime (for example, {%inference.region%}).
The configuration for an AWS_SERVICE_REQUEST function. Contains the target service, target Region, and request parameters that the function uses to call an AWS service API. For more information, see AWS_SERVICE_REQUEST in the MediaTailor User Guide.
A request contains unexpected data.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.mediatailor#BeaconEventType": { "type": "enum", "members": { "MUTE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MUTE" } }, "UNMUTE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNMUTE" } }, "PAUSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAUSE" } }, "SKIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIP" } } }, "traits": { "smithy.api#documentation": "A player operation event that MediaTailor can report on. Only the player can detect when a viewer performs this action, so MediaTailor doesn't send these beacons itself.
" } }, "com.amazonaws.mediatailor#BeaconEventTypeList": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#BeaconEventType" } }, "com.amazonaws.mediatailor#BeaconingConfiguration": { "type": "structure", "members": { "ClientSide": { "target": "com.amazonaws.mediatailor#ClientSideBeaconingConfiguration", "traits": { "smithy.api#documentation": "The beaconing settings for client-side reporting sessions. If you omit this object, MediaTailor uses INSIGHTS reporting mode.
The beaconing configuration for a playback configuration. Beaconing controls whether MediaTailor includes its own beacons in the ad tracking response, in addition to the ad server beacons.
" } }, "com.amazonaws.mediatailor#Bumper": { "type": "structure", "members": { "EndUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL for the end bumper asset.
" } }, "StartUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL for the start bumper asset.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.mediatailor#CdnConfiguration": { "type": "structure", "members": { "AdSegmentUrlPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
A content delivery network (CDN) to cache content segments, so that content requests don\u2019t 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.
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" } }, "com.amazonaws.mediatailor#Channel": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN of the channel.
", "smithy.api#required": {} } }, "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#required": {} } }, "ChannelState": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "Returns the state whether the channel is running or not.
", "smithy.api#required": {} } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp of when the channel was created.
" } }, "FillerSlate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { "smithy.api#documentation": "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.
The timestamp of when the channel was last modified.
" } }, "Outputs": { "target": "com.amazonaws.mediatailor#ResponseOutputs", "traits": { "smithy.api#documentation": "The channel's output properties.
", "smithy.api#required": {} } }, "PlaybackMode": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
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.
", "smithy.api#jsonName": "tags" } }, "Tier": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The tier for this channel. STANDARD tier channels can contain live programs.
", "smithy.api#required": {} } }, "LogConfiguration": { "target": "com.amazonaws.mediatailor#LogConfigurationForChannel", "traits": { "smithy.api#documentation": "The log configuration.
", "smithy.api#required": {} } }, "Audiences": { "target": "com.amazonaws.mediatailor#Audiences", "traits": { "smithy.api#documentation": "The list of audiences defined in channel.
" } } }, "traits": { "smithy.api#documentation": "The configuration parameters for a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", "smithy.api#references": [ { "resource": "com.amazonaws.mediatailor#ChannelResource" } ] } }, "com.amazonaws.mediatailor#ChannelPolicy": { "type": "resource", "identifiers": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string" } }, "put": { "target": "com.amazonaws.mediatailor#PutChannelPolicy" }, "read": { "target": "com.amazonaws.mediatailor#GetChannelPolicy" }, "delete": { "target": "com.amazonaws.mediatailor#DeleteChannelPolicy" }, "traits": { "aws.api#arn": { "template": "channel/{ChannelName}" }, "aws.cloudformation#cfnResource": { "name": "ChannelPolicy" }, "aws.iam#disableConditionKeyInference": {}, "smithy.api#unstable": {} } }, "com.amazonaws.mediatailor#ChannelResource": { "type": "resource", "identifiers": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string" } }, "put": { "target": "com.amazonaws.mediatailor#CreateChannel" }, "read": { "target": "com.amazonaws.mediatailor#DescribeChannel" }, "update": { "target": "com.amazonaws.mediatailor#UpdateChannel" }, "delete": { "target": "com.amazonaws.mediatailor#DeleteChannel" }, "list": { "target": "com.amazonaws.mediatailor#ListChannels" }, "operations": [ { "target": "com.amazonaws.mediatailor#ConfigureLogsForChannel" }, { "target": "com.amazonaws.mediatailor#CreateChannel" }, { "target": "com.amazonaws.mediatailor#GetChannelSchedule" }, { "target": "com.amazonaws.mediatailor#StartChannel" }, { "target": "com.amazonaws.mediatailor#StopChannel" } ], "resources": [ { "target": "com.amazonaws.mediatailor#ChannelPolicy" }, { "target": "com.amazonaws.mediatailor#ProgramResource" } ], "traits": { "aws.api#arn": { "template": "channel/{ChannelName}" }, "aws.api#taggable": {}, "aws.cloudformation#cfnResource": { "name": "Channel" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "channel", "relativeDocumentation": "channel-channelname.html" }, "smithy.api#documentation": "Represents a linear stream assembled from source manifests", "smithy.api#noReplace": {}, "smithy.api#unstable": {} } }, "com.amazonaws.mediatailor#ChannelState": { "type": "enum", "members": { "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } } } }, "com.amazonaws.mediatailor#ClientSideBeaconingConfiguration": { "type": "structure", "members": { "ReportingMode": { "target": "com.amazonaws.mediatailor#ClientSideBeaconingMode", "traits": { "smithy.api#documentation": "Specifies whether MediaTailor includes its beacons in the ad tracking response. Valid values, which are case-sensitive:
INSIGHTS \u2013 MediaTailor includes its beacons in the ad tracking response.
DISABLED \u2013 MediaTailor doesn't include its beacons in the ad tracking response.
If you send a ClientSide object, this setting is required. If you omit BeaconingConfiguration or ClientSide entirely, MediaTailor uses INSIGHTS.
PutPlaybackConfiguration replaces the whole playback configuration. To keep beaconing off, include DISABLED in every subsequent write.
The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.
The beaconing settings that apply to client-side reporting sessions: whether MediaTailor includes its beacons in the ad tracking response, and which player operation events it reports on.
" } }, "com.amazonaws.mediatailor#ClientSideBeaconingMode": { "type": "enum", "members": { "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Tracking response returned unmodified.", "smithy.api#enumValue": "DISABLED" } }, "INSIGHTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "EMT beacon URLs added alongside the ad server's. Effective default when\nBeaconingConfiguration is absent.", "smithy.api#enumValue": "INSIGHTS" } } } }, "com.amazonaws.mediatailor#ClipRange": { "type": "structure", "members": { "EndOffsetMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": 0, "smithy.api#documentation": "The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
" } }, "StartOffsetMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#documentation": "The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
" } } }, "traits": { "smithy.api#documentation": "Clip range configuration for the VOD source associated with the program.
" } }, "com.amazonaws.mediatailor#CompressionMethod": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "GZIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GZIP" } } } }, "com.amazonaws.mediatailor#ConcurrentExecutorConfiguration": { "type": "structure", "members": { "Runtime": { "target": "com.amazonaws.mediatailor#RuntimeType", "traits": { "smithy.api#documentation": "The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
A map of output bindings that controls which bindings the executor commits to the session state after all child functions complete. Each key is a namespaced output path, and each value is an expression that MediaTailor evaluates against the combined results of the child functions.
", "smithy.api#required": {} } }, "FunctionList": { "target": "com.amazonaws.mediatailor#__listOfFunctionsRef", "traits": { "smithy.api#documentation": "The list of child functions that MediaTailor runs in parallel. Each entry specifies a child function to execute and an optional run condition expression that controls whether the function runs.
", "smithy.api#required": {} } }, "TimeoutMilliseconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum time, in milliseconds, for all child functions to complete. This timeout covers every function in the list, including any HTTP calls the child functions make. If the executor exceeds this timeout, MediaTailor discards all output from the executor and proceeds with default behavior.
", "smithy.api#required": {} } }, "MaxConcurrency": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum number of child functions that MediaTailor runs simultaneously. When the list contains more functions than MaxConcurrency, MediaTailor starts additional functions as running ones complete, so that no more than MaxConcurrency functions run at the same time.
The configuration for a CONCURRENT_EXECUTOR function. A CONCURRENT_EXECUTOR runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete. For more information about functions, see Working with functions in the MediaTailor User Guide.
The dynamic variable that has aliases.
" } }, "value": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "Map of aliases to the value to be used at request time.
" } }, "traits": { "smithy.api#documentation": "The predefined aliases for dynamic variables.
" } }, "com.amazonaws.mediatailor#ConfigurationAliasesResponse": { "type": "map", "key": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dynamic variable that has aliases.
" } }, "value": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "Map of aliases to the value to be used at request time.
" } }, "traits": { "smithy.api#documentation": "The predefined aliases for dynamic variables.
" } }, "com.amazonaws.mediatailor#ConfigureLogsForChannel": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#ConfigureLogsForChannelRequest" }, "output": { "target": "com.amazonaws.mediatailor#ConfigureLogsForChannelResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to configure logs on the channel with the specified channel name", "relativeDocumentation": "configurelogs-channel.html", "resources": { "required": { "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Configures Amazon CloudWatch log settings for a channel.
", "smithy.api#http": { "method": "PUT", "uri": "/configureLogs/channel", "code": 200 } } }, "com.amazonaws.mediatailor#ConfigureLogsForChannelRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#required": {} } }, "LogTypes": { "target": "com.amazonaws.mediatailor#LogTypes", "traits": { "smithy.api#documentation": "The types of logs to collect.
", "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#ConfigureLogsForChannelResponse": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
" } }, "LogTypes": { "target": "com.amazonaws.mediatailor#LogTypes", "traits": { "smithy.api#documentation": "The types of logs collected.
" } } } }, "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationRequest" }, "output": { "target": "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to configure logs for a playback configuration", "relativeDocumentation": "configurelogs-playbackconfiguration.html", "requiredActions": [ "iam:CreateServiceLinkedRole" ], "resources": { "required": { "playbackConfiguration": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Defines where AWS Elemental MediaTailor sends logs for the playback configuration.
", "smithy.api#http": { "method": "PUT", "uri": "/configureLogs/playbackConfiguration", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationRequest": { "type": "structure", "members": { "PercentEnabled": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "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
The name of the playback configuration.
", "smithy.api#required": {} } }, "EnabledLoggingStrategies": { "target": "com.amazonaws.mediatailor#__listOfLoggingStrategies", "traits": { "smithy.api#documentation": "The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose LEGACY_CLOUDWATCH. To configure MediaTailor to send logs to CloudWatch, which then vends the logs to your destination of choice, choose VENDED_LOGS. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.
To use vended logs, you must configure the delivery destination in Amazon CloudWatch, as described in Enable logging from AWS services, Logging that requires additional permissions [V2].
" } }, "AdsInteractionLog": { "target": "com.amazonaws.mediatailor#AdsInteractionLog", "traits": { "smithy.api#documentation": "The event types that MediaTailor emits in logs for interactions with the ADS.
" } }, "ManifestServiceInteractionLog": { "target": "com.amazonaws.mediatailor#ManifestServiceInteractionLog", "traits": { "smithy.api#documentation": "The event types that MediaTailor emits in logs for interactions with the origin server.
" } } }, "traits": { "smithy.api#documentation": "Configures Amazon CloudWatch log settings for a playback configuration.
" } }, "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationResponse": { "type": "structure", "members": { "PercentEnabled": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.
", "smithy.api#required": {} } }, "PlaybackConfigurationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the playback configuration.
" } }, "EnabledLoggingStrategies": { "target": "com.amazonaws.mediatailor#__listOfLoggingStrategies", "traits": { "smithy.api#documentation": "The method used for collecting logs from AWS Elemental MediaTailor. LEGACY_CLOUDWATCH indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. VENDED_LOGS indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.
The event types that MediaTailor emits in logs for interactions with the ADS.
" } }, "ManifestServiceInteractionLog": { "target": "com.amazonaws.mediatailor#ManifestServiceInteractionLog", "traits": { "smithy.api#documentation": "The event types that MediaTailor emits in logs for interactions with the origin server.
" } } } }, "com.amazonaws.mediatailor#CreateChannel": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#CreateChannelRequest" }, "output": { "target": "com.amazonaws.mediatailor#CreateChannelResponse" }, "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a new channel", "relativeDocumentation": "channel-channelname.html", "createsResources": [ "channel" ], "resources": { "required": { "channel": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ] } } } }, "smithy.api#documentation": "Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/channel/{ChannelName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#CreateChannelRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "FillerSlate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { "smithy.api#documentation": "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.
The channel's output properties.
", "smithy.api#required": {} } }, "PlaybackMode": { "target": "com.amazonaws.mediatailor#PlaybackMode", "traits": { "smithy.api#documentation": "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.
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.
", "smithy.api#jsonName": "tags" } }, "Tier": { "target": "com.amazonaws.mediatailor#Tier", "traits": { "smithy.api#documentation": "The tier of the channel.
" } }, "TimeShiftConfiguration": { "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", "traits": { "smithy.api#documentation": "The time-shifted viewing configuration you want to associate to the channel.
" } }, "Audiences": { "target": "com.amazonaws.mediatailor#Audiences", "traits": { "smithy.api#documentation": "The list of audiences defined in channel.
" } } } }, "com.amazonaws.mediatailor#CreateChannelResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) to assign to the channel.
" } }, "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the channel.
" } }, "ChannelState": { "target": "com.amazonaws.mediatailor#ChannelState", "traits": { "smithy.api#documentation": "Indicates whether the channel is in a running state or not.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp of when the channel was created.
" } }, "FillerSlate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { "smithy.api#documentation": "Contains information about the slate used to fill gaps between programs in the schedule.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp of when the channel was last modified.
" } }, "Outputs": { "target": "com.amazonaws.mediatailor#ResponseOutputs", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The output properties to assign to the channel.
", "smithy.api#unstable": {} } }, "PlaybackMode": { "target": "com.amazonaws.mediatailor#__string", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The playback mode to assign to the channel.
", "smithy.api#unstable": {} } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } }, "Tier": { "target": "com.amazonaws.mediatailor#__string", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The tier of the channel.
", "smithy.api#unstable": {} } }, "TimeShiftConfiguration": { "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", "traits": { "smithy.api#documentation": "The time-shifted viewing configuration assigned to the channel.
" } }, "Audiences": { "target": "com.amazonaws.mediatailor#Audiences", "traits": { "smithy.api#documentation": "The list of audiences defined in channel.
" } } } }, "com.amazonaws.mediatailor#CreateLiveSource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#CreateLiveSourceRequest" }, "output": { "target": "com.amazonaws.mediatailor#CreateLiveSourceResponse" }, "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a new live source on the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname-livesource-livesourcename.html", "createsResources": [ "liveSource" ], "resources": { "required": { "liveSource": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ] } } } }, "smithy.api#documentation": "The live source configuration.
", "smithy.api#http": { "method": "POST", "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#CreateLiveSourceRequest": { "type": "structure", "members": { "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "A list of HTTP package configuration parameters for this live source.
", "smithy.api#required": {} } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the live source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#CreateLiveSourceResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN to assign to the live source.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The time the live source was created.
" } }, "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "A list of HTTP package configuration parameters for this live source.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The time the live source was last modified.
" } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the live source.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the source location of the live source.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#CreatePrefetchSchedule": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#CreatePrefetchScheduleRequest" }, "output": { "target": "com.amazonaws.mediatailor#CreatePrefetchScheduleResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a prefetch schedule for the playback configuration with the specified playback configuration name", "relativeDocumentation": "prefetchschedule-playbackconfigurationname-name.html", "createsResources": [ "prefetchSchedule" ], "resources": { "required": { "playbackConfiguration": {} } } }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "POST", "uri": "/prefetchSchedule/{PlaybackConfigurationName}/{Name}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#CreatePrefetchScheduleRequest": { "type": "structure", "members": { "Consumption": { "target": "com.amazonaws.mediatailor#PrefetchConsumption", "traits": { "smithy.api#documentation": "The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. 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": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the schedule request.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PlaybackConfigurationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the playback configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Retrieval": { "target": "com.amazonaws.mediatailor#PrefetchRetrieval", "traits": { "smithy.api#documentation": "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.
" } }, "RecurringPrefetchConfiguration": { "target": "com.amazonaws.mediatailor#RecurringPrefetchConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines how and when MediaTailor performs ad prefetching in a live event.
" } }, "ScheduleType": { "target": "com.amazonaws.mediatailor#PrefetchScheduleType", "traits": { "smithy.api#documentation": "The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.
For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.
" } }, "StreamId": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
The tags to assign to the prefetch schedule. 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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#CreatePrefetchScheduleResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN to assign to the prefetch schedule.
" } }, "Consumption": { "target": "com.amazonaws.mediatailor#PrefetchConsumption", "traits": { "smithy.api#documentation": "The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. 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": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the prefetch schedule.
" } }, "PlaybackConfigurationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the playback configuration.
" } }, "Retrieval": { "target": "com.amazonaws.mediatailor#PrefetchRetrieval", "traits": { "smithy.api#documentation": "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.
" } }, "RecurringPrefetchConfiguration": { "target": "com.amazonaws.mediatailor#RecurringPrefetchConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines how MediaTailor performs recurring prefetch.
" } }, "ScheduleType": { "target": "com.amazonaws.mediatailor#PrefetchScheduleType", "traits": { "smithy.api#documentation": "The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.
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.
The tags assigned to the prefetch schedule. 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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#CreateProgram": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#CreateProgramRequest" }, "output": { "target": "com.amazonaws.mediatailor#CreateProgramResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a new program on the channel with the specified channel name", "relativeDocumentation": "channel-channelname-program-programname.html" }, "smithy.api#documentation": "Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/channel/{ChannelName}/program/{ProgramName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#CreateProgramRequest": { "type": "structure", "members": { "AdBreaks": { "target": "com.amazonaws.mediatailor#__listOfAdBreak", "traits": { "smithy.api#documentation": "The ad break configuration settings.
" } }, "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel for this Program.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the LiveSource for this Program.
" } }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the Program.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ScheduleConfiguration": { "target": "com.amazonaws.mediatailor#ScheduleConfiguration", "traits": { "smithy.api#documentation": "The schedule configuration settings.
", "smithy.api#required": {} } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location.
", "smithy.api#required": {} } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name that's used to refer to a VOD source.
" } }, "AudienceMedia": { "target": "com.amazonaws.mediatailor#__listOfAudienceMedia", "traits": { "smithy.api#documentation": "The list of AudienceMedia defined in program.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags to assign to the program. 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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#CreateProgramResponse": { "type": "structure", "members": { "AdBreaks": { "target": "com.amazonaws.mediatailor#__listOfAdBreak", "traits": { "smithy.api#documentation": "The ad break configuration settings.
" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN to assign to the program.
" } }, "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the channel for this program.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The time the program was created.
" } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the LiveSource for this Program.
" } }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to this program.
" } }, "ScheduledStartTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The scheduled start time for this Program.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the source location for this program.
" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name that's used to refer to a VOD source.
" } }, "ClipRange": { "target": "com.amazonaws.mediatailor#ClipRange", "traits": { "smithy.api#documentation": "The clip range configuration settings.
" } }, "DurationMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#documentation": "The duration of the live program in milliseconds.
" } }, "AudienceMedia": { "target": "com.amazonaws.mediatailor#__listOfAudienceMedia", "traits": { "smithy.api#documentation": "The list of AudienceMedia defined in program.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned to the program. 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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#CreateSourceLocation": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#CreateSourceLocationRequest" }, "output": { "target": "com.amazonaws.mediatailor#CreateSourceLocationResponse" }, "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a new source location", "relativeDocumentation": "sourcelocation-sourcelocationname.html", "createsResources": [ "sourceLocation" ], "resources": { "required": { "sourceLocation": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ] } } } }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "POST", "uri": "/sourceLocation/{SourceLocationName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#CreateSourceLocationRequest": { "type": "structure", "members": { "AccessConfiguration": { "target": "com.amazonaws.mediatailor#AccessConfiguration", "traits": { "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" } }, "DefaultSegmentDeliveryConfiguration": { "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "The optional configuration for the server that serves segments.
" } }, "HttpConfiguration": { "target": "com.amazonaws.mediatailor#HttpConfiguration", "traits": { "smithy.api#documentation": "The source's HTTP package configurations.
", "smithy.api#required": {} } }, "SegmentDeliveryConfigurations": { "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "A list of the segment delivery configurations associated with this resource.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name associated with the source location.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#CreateSourceLocationResponse": { "type": "structure", "members": { "AccessConfiguration": { "target": "com.amazonaws.mediatailor#AccessConfiguration", "traits": { "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN to assign to the source location.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The time the source location was created.
" } }, "DefaultSegmentDeliveryConfiguration": { "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "The optional configuration for the server that serves segments.
" } }, "HttpConfiguration": { "target": "com.amazonaws.mediatailor#HttpConfiguration", "traits": { "smithy.api#documentation": "The source's HTTP package configurations.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The time the source location was last modified.
" } }, "SegmentDeliveryConfigurations": { "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "The segment delivery configurations for the source location. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the source location.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#CreateVodSource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#CreateVodSourceRequest" }, "output": { "target": "com.amazonaws.mediatailor#CreateVodSourceResponse" }, "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a new VOD source on the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname-vodsource-vodsourcename.html", "createsResources": [ "vodSource" ], "resources": { "required": { "vodSource": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ] } } } }, "smithy.api#documentation": "The VOD source configuration parameters.
", "smithy.api#http": { "method": "POST", "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#CreateVodSourceRequest": { "type": "structure", "members": { "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "A list of HTTP package configuration parameters for this VOD source.
", "smithy.api#required": {} } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location for this VOD source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name associated with the VOD source.>
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#CreateVodSourceResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN to assign to this VOD source.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The time the VOD source was created.
" } }, "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "A list of HTTP package configuration parameters for this VOD source.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The time the VOD source was last modified.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the source location for this VOD source.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the VOD source.
" } } } }, "com.amazonaws.mediatailor#CustomOutputConfiguration": { "type": "structure", "members": { "Runtime": { "target": "com.amazonaws.mediatailor#RuntimeType", "traits": { "smithy.api#documentation": "The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.variant), and each value is an expression that MediaTailor evaluates at runtime against the current session state. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.
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.
The URL that MediaTailor generates to initiate a playback session. The session uses server-side reporting.
" } }, "DualStackManifestEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dual-stack (IPv4 and IPv6) URL that MediaTailor generates to initiate a playback session. The session uses server-side reporting.
" } }, "MpdLocation": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
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.
The configuration for DASH content.
" } }, "com.amazonaws.mediatailor#DashConfigurationForPut": { "type": "structure", "members": { "MpdLocation": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
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.
The configuration for DASH PUT operations.
" } }, "com.amazonaws.mediatailor#DashPlaylistSettings": { "type": "structure", "members": { "ManifestWindowSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
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.
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.
Dash manifest configuration parameters.
" } }, "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration": { "type": "structure", "members": { "BaseUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.mediatailor#DeleteChannel": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DeleteChannelRequest" }, "output": { "target": "com.amazonaws.mediatailor#DeleteChannelResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the channel with the specified channel name", "relativeDocumentation": "channel-channelname.html", "resources": { "required": { "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", "smithy.api#http": { "method": "DELETE", "uri": "/channel/{ChannelName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#DeleteChannelPolicy": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DeleteChannelPolicyRequest" }, "output": { "target": "com.amazonaws.mediatailor#DeleteChannelPolicyResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the IAM policy on the channel with the specified channel name", "relativeDocumentation": "channel-channelname-policy.html", "resources": { "required": { "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "The channel policy to delete.
", "smithy.api#http": { "method": "DELETE", "uri": "/channel/{ChannelName}/policy", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#DeleteChannelPolicyRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel associated with this channel policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "aws.api#data": "permissions" } }, "com.amazonaws.mediatailor#DeleteChannelPolicyResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#DeleteChannelRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DeleteChannelResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#DeleteFunction": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DeleteFunctionRequest" }, "output": { "target": "com.amazonaws.mediatailor#DeleteFunctionResponse" }, "traits": { "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "DELETE", "uri": "/function/{FunctionId}", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#DeleteFunctionRequest": { "type": "structure", "members": { "FunctionId": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier of the function to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.mediatailor#FunctionResource" } ] } }, "com.amazonaws.mediatailor#DeleteFunctionResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.mediatailor#DeleteLiveSource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DeleteLiveSourceRequest" }, "output": { "target": "com.amazonaws.mediatailor#DeleteLiveSourceResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the live source with the specified live source name on the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname-livesource-livesourcename.html", "resources": { "required": { "liveSource": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "The live source to delete.
", "smithy.api#http": { "method": "DELETE", "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#DeleteLiveSourceRequest": { "type": "structure", "members": { "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the live source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location associated with this Live Source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DeleteLiveSourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#DeletePlaybackConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DeletePlaybackConfigurationRequest" }, "output": { "target": "com.amazonaws.mediatailor#DeletePlaybackConfigurationResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the specified playback configuration", "relativeDocumentation": "playbackconfiguration-name.html", "resources": { "required": { "playbackConfiguration": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", "smithy.api#http": { "method": "DELETE", "uri": "/playbackConfiguration/{Name}", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#DeletePlaybackConfigurationRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the playback configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DeletePlaybackConfigurationResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#DeletePrefetchSchedule": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DeletePrefetchScheduleRequest" }, "output": { "target": "com.amazonaws.mediatailor#DeletePrefetchScheduleResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a prefetch schedule for a playback configuration with the specified prefetch schedule name", "relativeDocumentation": "prefetchschedule-playbackconfigurationname-name.html", "resources": { "required": { "playbackConfiguration": {}, "prefetchSchedule": {} } } }, "smithy.api#documentation": "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.
The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PlaybackConfigurationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the playback configuration for this prefetch schedule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DeletePrefetchScheduleResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#DeleteProgram": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DeleteProgramRequest" }, "output": { "target": "com.amazonaws.mediatailor#DeleteProgramResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the program with the specified program name on the channel with the specified channel name", "relativeDocumentation": "channel-channelname-program-programname.html", "resources": { "required": { "program": {} } } }, "smithy.api#documentation": "Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
", "smithy.api#http": { "method": "DELETE", "uri": "/channel/{ChannelName}/program/{ProgramName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#DeleteProgramRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the program.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DeleteProgramResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#DeleteSourceLocation": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DeleteSourceLocationRequest" }, "output": { "target": "com.amazonaws.mediatailor#DeleteSourceLocationResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname.html", "resources": { "required": { "sourceLocation": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "DELETE", "uri": "/sourceLocation/{SourceLocationName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#DeleteSourceLocationRequest": { "type": "structure", "members": { "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DeleteSourceLocationResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#DeleteVodSource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DeleteVodSourceRequest" }, "output": { "target": "com.amazonaws.mediatailor#DeleteVodSourceResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete the VOD source with the specified VOD source name on the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname-vodsource-vodsourcename.html", "resources": { "required": { "vodSource": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "The video on demand (VOD) source to delete.
", "smithy.api#http": { "method": "DELETE", "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#DeleteVodSourceRequest": { "type": "structure", "members": { "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location associated with this VOD Source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the VOD source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DeleteVodSourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#DescribeChannel": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DescribeChannelRequest" }, "output": { "target": "com.amazonaws.mediatailor#DescribeChannelResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the channel with the specified channel name", "relativeDocumentation": "channel-channelname.html", "resources": { "required": { "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", "smithy.api#http": { "method": "GET", "uri": "/channel/{ChannelName}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#DescribeChannelRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DescribeChannelResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN of the channel.
" } }, "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
" } }, "ChannelState": { "target": "com.amazonaws.mediatailor#ChannelState", "traits": { "smithy.api#documentation": "Indicates whether the channel is in a running state or not.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp of when the channel was created.
" } }, "FillerSlate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { "smithy.api#documentation": "Contains information about the slate used to fill gaps between programs in the schedule.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp of when the channel was last modified.
" } }, "Outputs": { "target": "com.amazonaws.mediatailor#ResponseOutputs", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The channel's output properties.
", "smithy.api#unstable": {} } }, "PlaybackMode": { "target": "com.amazonaws.mediatailor#__string", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The channel's playback mode.
", "smithy.api#unstable": {} } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned 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.
", "smithy.api#jsonName": "tags" } }, "Tier": { "target": "com.amazonaws.mediatailor#__string", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The channel's tier.
", "smithy.api#unstable": {} } }, "LogConfiguration": { "target": "com.amazonaws.mediatailor#LogConfigurationForChannel", "traits": { "smithy.api#documentation": "The log configuration for the channel.
", "smithy.api#required": {} } }, "TimeShiftConfiguration": { "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", "traits": { "smithy.api#documentation": "The time-shifted viewing configuration for the channel.
" } }, "Audiences": { "target": "com.amazonaws.mediatailor#Audiences", "traits": { "smithy.api#documentation": "The list of audiences defined in channel.
" } } } }, "com.amazonaws.mediatailor#DescribeLiveSource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DescribeLiveSourceRequest" }, "output": { "target": "com.amazonaws.mediatailor#DescribeLiveSourceResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the live source with the specified live source name on the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname-livesource-livesourcename.html", "resources": { "required": { "liveSource": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "The live source to describe.
", "smithy.api#http": { "method": "GET", "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#DescribeLiveSourceRequest": { "type": "structure", "members": { "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the live source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location associated with this Live Source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DescribeLiveSourceResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN of the live source.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the live source was created.
" } }, "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "The HTTP package configurations.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the live source was modified.
" } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the live source.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location associated with the live source.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned 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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#DescribeProgram": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DescribeProgramRequest" }, "output": { "target": "com.amazonaws.mediatailor#DescribeProgramResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the program with the specified program name on the channel with the specified channel name", "relativeDocumentation": "channel-channelname-program-programname.html", "resources": { "required": { "program": {} } } }, "smithy.api#documentation": "Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
", "smithy.api#http": { "method": "GET", "uri": "/channel/{ChannelName}/program/{ProgramName}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#DescribeProgramRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel associated with this Program.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the program.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DescribeProgramResponse": { "type": "structure", "members": { "AdBreaks": { "target": "com.amazonaws.mediatailor#__listOfAdBreak", "traits": { "smithy.api#documentation": "The ad break configuration settings.
" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN of the program.
" } }, "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel that the program belongs to.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp of when the program was created.
" } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the LiveSource for this Program.
" } }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the program.
" } }, "ScheduledStartTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The source location name.
" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name that's used to refer to a VOD source.
" } }, "ClipRange": { "target": "com.amazonaws.mediatailor#ClipRange", "traits": { "smithy.api#documentation": "The clip range configuration settings.
" } }, "DurationMillis": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The duration of the live program in milliseconds.
" } }, "AudienceMedia": { "target": "com.amazonaws.mediatailor#__listOfAudienceMedia", "traits": { "smithy.api#documentation": "The list of AudienceMedia defined in program.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned to the program. 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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#DescribeSourceLocation": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DescribeSourceLocationRequest" }, "output": { "target": "com.amazonaws.mediatailor#DescribeSourceLocationResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname.html", "resources": { "required": { "sourceLocation": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "GET", "uri": "/sourceLocation/{SourceLocationName}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#DescribeSourceLocationRequest": { "type": "structure", "members": { "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DescribeSourceLocationResponse": { "type": "structure", "members": { "AccessConfiguration": { "target": "com.amazonaws.mediatailor#AccessConfiguration", "traits": { "smithy.api#documentation": "The access configuration for the source location.
" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN of the source location.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the source location was created.
" } }, "DefaultSegmentDeliveryConfiguration": { "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "The default segment delivery configuration settings.
" } }, "HttpConfiguration": { "target": "com.amazonaws.mediatailor#HttpConfiguration", "traits": { "smithy.api#documentation": "The HTTP package configuration settings for the source location.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the source location was last modified.
" } }, "SegmentDeliveryConfigurations": { "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "A list of the segment delivery configurations associated with this resource.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned 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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#DescribeVodSource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#DescribeVodSourceRequest" }, "output": { "target": "com.amazonaws.mediatailor#DescribeVodSourceResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the VOD source with the specified VOD source name on the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname-vodsource-vodsourcename.html", "resources": { "required": { "vodSource": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Provides details about a specific video on demand (VOD) source in a specific source location.
", "smithy.api#http": { "method": "GET", "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#DescribeVodSourceRequest": { "type": "structure", "members": { "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location associated with this VOD Source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the VOD Source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#DescribeVodSourceResponse": { "type": "structure", "members": { "AdBreakOpportunities": { "target": "com.amazonaws.mediatailor#AdBreakOpportunities", "traits": { "smithy.api#documentation": "The ad break opportunities within the VOD source.
" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN of the VOD source.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the VOD source was created.
" } }, "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "The HTTP package configurations.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The last modified time of the VOD source.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location associated with the VOD source.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned 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.
", "smithy.api#jsonName": "tags" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the VOD source.
" } } } }, "com.amazonaws.mediatailor#EventName": { "type": "enum", "members": { "PRE_SESSION_INITIALIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_SESSION_INITIALIZATION" } }, "PRE_ADS_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_ADS_REQUEST" } }, "POST_ADS_RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST_ADS_RESPONSE" } }, "PRE_MANIFEST_INSERTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_MANIFEST_INSERTION" } }, "POST_ORIGIN_RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST_ORIGIN_RESPONSE" } } } }, "com.amazonaws.mediatailor#FillPolicy": { "type": "enum", "members": { "FULL_AVAIL_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FULL_AVAIL_ONLY" } }, "PARTIAL_AVAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIAL_AVAIL" } } } }, "com.amazonaws.mediatailor#Function": { "type": "structure", "members": { "FunctionId": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier of the function.
", "smithy.api#required": {} } }, "FunctionType": { "target": "com.amazonaws.mediatailor#FunctionType", "traits": { "smithy.api#documentation": "The type of the function.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "A description of the function.
" } }, "HttpRequestConfiguration": { "target": "com.amazonaws.mediatailor#HttpRequestConfiguration", "traits": { "smithy.api#documentation": "The configuration for an HTTP_REQUEST function.
The configuration for an AWS_SERVICE_REQUEST function. Specifies the target service, target Region, and request parameters.
The configuration for a CUSTOM_OUTPUT function.
The configuration for a CONCURRENT_EXECUTOR function.
The configuration for a SEQUENTIAL_EXECUTOR function.
The configuration for a VAST_REQUEST function.
The configuration for an HLS_TAG_PROCESSOR function.
The tags assigned to the function. 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.
", "smithy.api#jsonName": "tags" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function.
" } } }, "traits": { "smithy.api#documentation": "Defines reusable logic that MediaTailor executes at lifecycle hooks during ad insertion. The FunctionType determines the function's runtime behavior. For more information about functions, see Working with functions in the MediaTailor User Guide.
An optional expression that evaluates to a boolean. MediaTailor evaluates this expression immediately before running the step, using the accumulated state at that point in the sequence. If the expression evaluates to false, MediaTailor skips the step and moves to the next one. If omitted, the step always runs.
The identifier of the child function to execute in this step.
" } }, "Alias": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "An optional alternate name for the function within the executor. If omitted, MediaTailor uses the function identifier.
" } } }, "traits": { "smithy.api#documentation": "A reference to a child function within a SEQUENTIAL_EXECUTOR function.
The type of a function, which determines what the function can do at runtime. For more information, see Function types and composition in the MediaTailor User Guide.
" } }, "com.amazonaws.mediatailor#GetChannelPolicy": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#GetChannelPolicyRequest" }, "output": { "target": "com.amazonaws.mediatailor#GetChannelPolicyResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to read the IAM policy on the channel with the specified channel name", "relativeDocumentation": "channel-channelname-policy.html", "resources": { "required": { "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Returns the channel's IAM policy. IAM policies are used to control access to your channel.
", "smithy.api#http": { "method": "GET", "uri": "/channel/{ChannelName}/policy", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#GetChannelPolicyRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel associated with this Channel Policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#GetChannelPolicyResponse": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The IAM policy for the channel. IAM policies are used to control access to your channel.
" } } } }, "com.amazonaws.mediatailor#GetChannelSchedule": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#GetChannelScheduleRequest" }, "output": { "target": "com.amazonaws.mediatailor#GetChannelScheduleResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the schedule of programs on the channel with the specified channel name", "relativeDocumentation": "channel-channelname-schedule.html", "resources": { "required": { "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Retrieves information about your channel's schedule.
", "smithy.api#http": { "method": "GET", "uri": "/channel/{ChannelName}/schedule", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#GetChannelScheduleRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel associated with this Channel Schedule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DurationMinutes": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The duration in minutes of the channel schedule.
", "smithy.api#httpQuery": "durationMinutes" } }, "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { "smithy.api#documentation": "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.
(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.
The single audience for GetChannelScheduleRequest.
", "smithy.api#httpQuery": "audience" } } } }, "com.amazonaws.mediatailor#GetChannelScheduleResponse": { "type": "structure", "members": { "Items": { "target": "com.amazonaws.mediatailor#__listOfScheduleEntry", "traits": { "smithy.api#documentation": "A list of schedule entries for the channel.
" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" } } } }, "com.amazonaws.mediatailor#GetFunction": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#GetFunctionRequest" }, "output": { "target": "com.amazonaws.mediatailor#GetFunctionResponse" }, "traits": { "smithy.api#documentation": "Retrieves the configuration and metadata for a function. For more information about functions, see Working with functions in the MediaTailor User Guide.
", "smithy.api#http": { "method": "GET", "uri": "/function/{FunctionId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#GetFunctionRequest": { "type": "structure", "members": { "FunctionId": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier of the function.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "-- Request/Response DataStructures --", "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.mediatailor#FunctionResource" } ] } }, "com.amazonaws.mediatailor#GetFunctionResponse": { "type": "structure", "members": { "FunctionId": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier of the function.
", "smithy.api#required": {} } }, "FunctionType": { "target": "com.amazonaws.mediatailor#FunctionType", "traits": { "smithy.api#documentation": "The type of the function.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "A description of the function.
" } }, "HttpRequestConfiguration": { "target": "com.amazonaws.mediatailor#HttpRequestConfiguration", "traits": { "smithy.api#documentation": "The configuration for an HTTP_REQUEST function.
The configuration for an AWS_SERVICE_REQUEST function. Specifies the target service, target Region, and request parameters.
The configuration for a CUSTOM_OUTPUT function.
The configuration for a CONCURRENT_EXECUTOR function.
The configuration for a SEQUENTIAL_EXECUTOR function.
The configuration for a VAST_REQUEST function.
The configuration for an HLS_TAG_PROCESSOR function.
The tags assigned to the function. 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.
", "smithy.api#jsonName": "tags" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function.
" } } }, "traits": { "smithy.api#documentation": "-- Define Mixin --", "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.mediatailor#FunctionResource" } ] } }, "com.amazonaws.mediatailor#GetPlaybackConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#GetPlaybackConfigurationRequest" }, "output": { "target": "com.amazonaws.mediatailor#GetPlaybackConfigurationResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the configuration for the specified name", "relativeDocumentation": "playbackconfiguration-name.html", "resources": { "required": { "playbackConfiguration": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", "smithy.api#http": { "method": "GET", "uri": "/playbackConfiguration/{Name}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#GetPlaybackConfigurationRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier for the playback configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#GetPlaybackConfigurationResponse": { "type": "structure", "members": { "AdDecisionServerUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#AvailSuppression", "traits": { "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" } }, "Bumper": { "target": "com.amazonaws.mediatailor#Bumper", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#CdnConfiguration", "traits": { "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" } }, "ConfigurationAliases": { "target": "com.amazonaws.mediatailor#ConfigurationAliasesResponse", "traits": { "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" } }, "DashConfiguration": { "target": "com.amazonaws.mediatailor#DashConfiguration", "traits": { "smithy.api#documentation": "The configuration for DASH content.
" } }, "HlsConfiguration": { "target": "com.amazonaws.mediatailor#HlsConfiguration", "traits": { "smithy.api#documentation": "The configuration for HLS content.
" } }, "InsertionMode": { "target": "com.amazonaws.mediatailor#InsertionMode", "traits": { "smithy.api#default": "STITCHED_ONLY", "smithy.api#documentation": "The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT 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.
The configuration for pre-roll ad insertion.
" } }, "LogConfiguration": { "target": "com.amazonaws.mediatailor#LogConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.
" } }, "ManifestProcessingRules": { "target": "com.amazonaws.mediatailor#ManifestProcessingRules", "traits": { "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" } }, "Name": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier for the playback configuration.
" } }, "PersonalizationThresholdSeconds": { "target": "com.amazonaws.mediatailor#__integerMin1", "traits": { "smithy.api#documentation": "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.
" } }, "PlaybackConfigurationArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the playback configuration.
" } }, "PlaybackEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL that your player accesses to get a manifest from AWS Elemental MediaTailor. The session uses server-side reporting.
" } }, "DualStackPlaybackEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dual-stack (IPv4 and IPv6) URL that your player accesses to get a manifest from AWS Elemental MediaTailor. The session uses server-side reporting.
" } }, "SessionInitializationEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL that your player uses to initialize a session that uses client-side reporting.
" } }, "DualStackSessionInitializationEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dual-stack (IPv4 and IPv6) URL that your player uses to initialize a session that uses client-side reporting.
" } }, "SlateAdUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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 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.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned 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.
", "smithy.api#jsonName": "tags" } }, "TranscodeProfileName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" } }, "AdConditioningConfiguration": { "target": "com.amazonaws.mediatailor#AdConditioningConfiguration", "traits": { "smithy.api#documentation": "The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.
" } }, "AdDecisionServerConfiguration": { "target": "com.amazonaws.mediatailor#AdDecisionServerConfiguration", "traits": { "smithy.api#documentation": "The configuration for customizing HTTP requests to the ad decision server (ADS). This includes settings for request method, headers, body content, and compression options.
" } }, "YieldOptimizationConfiguration": { "target": "com.amazonaws.mediatailor#YieldOptimizationConfiguration", "traits": { "smithy.api#documentation": "Configuration for Yield Optimization, which fills unsold ad inventory in ad breaks with programmatic ads from Amazon Publisher Services (APS).
" } }, "FunctionMapping": { "target": "com.amazonaws.mediatailor#FunctionMapping", "traits": { "smithy.api#documentation": "A map of lifecycle hook event names to function identifiers. The function mapping specifies which function MediaTailor executes at each lifecycle hook during ad insertion. Valid keys are PRE_SESSION_INITIALIZATION, POST_ORIGIN_RESPONSE, PRE_ADS_REQUEST, POST_ADS_RESPONSE, and PRE_MANIFEST_INSERTION. For more information, see Functions lifecycle hooks in the MediaTailor User Guide.
The timeout settings for ad decision server interactions. These settings control how long MediaTailor waits for ADS responses and the total time budget for ad personalization across live, VOD, and prefetch workflows.
" } }, "AdsPersonalizationConcurrency": { "target": "com.amazonaws.mediatailor#AdsPersonalizationConcurrency", "traits": { "smithy.api#documentation": "The concurrency settings for ad decision server interactions. These settings control how many simultaneous ADS requests MediaTailor makes per manifest request.
" } }, "BeaconingConfiguration": { "target": "com.amazonaws.mediatailor#BeaconingConfiguration", "traits": { "smithy.api#documentation": "The beaconing configuration for this playback configuration, which controls whether MediaTailor includes beacons of its own in the ad tracking response. MediaTailor always returns this setting. If you created the playback configuration before this setting existed, MediaTailor reports ReportingMode as INSIGHTS. This is also the value MediaTailor uses for that configuration at playback time.
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.
", "smithy.api#http": { "method": "GET", "uri": "/prefetchSchedule/{PlaybackConfigurationName}/{Name}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#GetPrefetchScheduleRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PlaybackConfigurationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
The Amazon Resource Name (ARN) of the prefetch schedule.
" } }, "Consumption": { "target": "com.amazonaws.mediatailor#PrefetchConsumption", "traits": { "smithy.api#documentation": "The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. 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": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
" } }, "PlaybackConfigurationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the playback configuration to create the prefetch schedule for.
" } }, "Retrieval": { "target": "com.amazonaws.mediatailor#PrefetchRetrieval", "traits": { "smithy.api#documentation": "A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
" } }, "ScheduleType": { "target": "com.amazonaws.mediatailor#PrefetchScheduleType", "traits": { "smithy.api#documentation": "The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.
The configuration that defines how and when MediaTailor performs ad prefetching in a live event.
" } }, "StreamId": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned to the prefetch schedule. 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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#HlsConfiguration": { "type": "structure", "members": { "ManifestEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL that MediaTailor generates to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
" } }, "DualStackManifestEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dual-stack (IPv4 and IPv6) URL that MediaTailor generates to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
" } } }, "traits": { "smithy.api#documentation": "The configuration for HLS content.
" } }, "com.amazonaws.mediatailor#HlsPlaylistSettings": { "type": "structure", "members": { "ManifestWindowSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
HLS playlist configuration parameters.
" } }, "com.amazonaws.mediatailor#HlsTagName": { "type": "enum", "members": { "EXT_X_DATERANGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The EXT-X-DATERANGE tag in an HLS media playlist.
The name of an HLS tag that an HLS_TAG_PROCESSOR function can match. The only supported value is EXT-X-DATERANGE.
The expression language used to evaluate expressions in the function configuration. The only supported value is JSONATA.
A map of output bindings that MediaTailor evaluates for each HLS tag that matches TagFilter and, when specified, passes RunCondition. The required tag binding must return exactly one tag action: $updateTag, $removeTag, or $passthroughTag. Optional player_params.<name> bindings write strings, numbers, or booleans that persist for the player session. Optional temp.<name> bindings hold any JSON value for the current invocation and are not persisted. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.
A list of HLS tag names that trigger function evaluation. Specify [\"EXT-X-DATERANGE\"].
The configuration for an HLS_TAG_PROCESSOR function. Specifies the HLS tags that trigger evaluation, an optional run condition, and output expressions. Each evaluation must update, remove, or pass through the matching tag and can also write player session parameters or temporary values. For more information, see HLS_TAG_PROCESSOR in the MediaTailor User Guide.
The base URL for the source location host server. This string must include the protocol, such as https://.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The HTTP configuration for the source location.
" } }, "com.amazonaws.mediatailor#HttpPackageConfiguration": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
The streaming protocol for this package configuration. Supported values are HLS and DASH.
The HTTP package configuration properties for the requested VOD source.
" } }, "com.amazonaws.mediatailor#HttpPackageConfigurations": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#HttpPackageConfiguration" }, "traits": { "smithy.api#documentation": "The VOD source's HTTP package configuration settings.
" } }, "com.amazonaws.mediatailor#HttpRequest": { "type": "structure", "members": { "Method": { "target": "com.amazonaws.mediatailor#Method", "traits": { "smithy.api#documentation": "The HTTP method to use when making requests to the ad decision server. Supported values are GET and POST.
The request body content to send with HTTP requests to the ad decision server. This value is only eligible for POST requests.
Custom HTTP headers to include in requests to the ad decision server. Specify headers as key-value pairs. This value is only eligible for POST requests.
The compression method to apply to requests sent to the ad decision server. Supported values are NONE and GZIP. This value is only eligible for POST requests.
HTTP request configuration parameters that define how MediaTailor communicates with the ad decision server.
" } }, "com.amazonaws.mediatailor#HttpRequestCacheConfiguration": { "type": "structure", "members": { "TtlMinimumSeconds": { "target": "com.amazonaws.mediatailor#__integerMin1", "traits": { "smithy.api#documentation": "The lower bound, in seconds, on how long MediaTailor caches a response. MediaTailor also uses this value as the cache duration when a response has no Cache-Control max-age directive.
The upper bound, in seconds, on how long MediaTailor caches a response. This value must be greater than or equal to TtlMinimumSeconds.
A JSONata expression that MediaTailor evaluates to a custom cache key. By default, the cache key is a hash of the HTTP URL, the request body, and the HTTP method; request headers are not included. You can specify a custom cache key expression to vary caching by request headers and more. The evaluated key must be smaller than 1 KB; otherwise the HTTP function will fail.
" } } }, "traits": { "smithy.api#documentation": "The optional response-caching configuration shared by the HTTP-based function types (HTTP_REQUEST, AWS_SERVICE_REQUEST, and VAST_REQUEST). When you provide this configuration, MediaTailor caches the function's responses that have one of the following HTTP status codes: 200, 203, 204, 404, 405, 410, 414, and 501. For a cacheable response, MediaTailor caches it for the number of seconds given by the response's Cache-Control max-age directive, limited to the range between TtlMinimumSeconds and TtlMaximumSeconds. If the response has no Cache-Control max-age directive, MediaTailor caches it for TtlMinimumSeconds seconds. Cached HTTP responses are scoped per playback configuration, not per function.
The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.identity), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in an HTTP_REQUEST function can reference the response object returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.
The HTTP method for the request. Valid values: GET and POST.
The maximum time, in milliseconds, that MediaTailor waits for a response from the external service. If the call exceeds this timeout, MediaTailor sets the response status code to null and proceeds with output expression evaluation. Valid values: 100 to 2000.
An expression that evaluates to the request URL. Use {%...%} delimiters for dynamic expressions. The maximum length after evaluation is 2,048 characters.
An expression that evaluates to the request body. Used with POST requests. The maximum size after evaluation is 64 KB.
A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound HTTP request. Maximum 50 headers.
" } }, "Cache": { "target": "com.amazonaws.mediatailor#HttpRequestCacheConfiguration", "traits": { "smithy.api#documentation": "The optional response-caching configuration for the function. When present, MediaTailor caches the responses that the function receives from the HTTP endpoint, within the time-to-live (TTL) bounds that you specify. Omit this configuration to disable response caching.
" } } }, "traits": { "smithy.api#documentation": "The configuration for an HTTP_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions for the request. For more information, see HTTP_REQUEST in the MediaTailor User Guide.
Insertion Mode controls whether players can use stitched or guided ad insertion.
" } }, "com.amazonaws.mediatailor#KeyValuePair": { "type": "structure", "members": { "Key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the EXT-X-ASSETtag. If you specify a key, you must also specify a corresponding value.
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the EXT-X-ASSETtag. If you specify a value, you must also specify a corresponding key.
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the EXT-X-ASSETtag.
Lists the alerts that are associated with a MediaTailor channel assembly resource.
", "smithy.api#http": { "method": "GET", "uri": "/alerts", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#ListAlertsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { "smithy.api#documentation": "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.
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
For the first ListAlerts request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.
The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#ListAlertsResponse": { "type": "structure", "members": { "Items": { "target": "com.amazonaws.mediatailor#__listOfAlert", "traits": { "smithy.api#documentation": "A list of alerts that are associated with this resource.
" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" } } } }, "com.amazonaws.mediatailor#ListChannels": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#ListChannelsRequest" }, "output": { "target": "com.amazonaws.mediatailor#ListChannelsResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the list of existing channels", "relativeDocumentation": "channels.html" }, "smithy.api#documentation": "Retrieves information about the channels that are associated with the current AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/channels", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#ListChannelsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { "smithy.api#documentation": "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.
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
For the first ListChannels request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.
A list of channels that are associated with this account.
" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" } } } }, "com.amazonaws.mediatailor#ListFunctions": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#ListFunctionsRequest" }, "output": { "target": "com.amazonaws.mediatailor#ListFunctionsResponse" }, "traits": { "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "GET", "uri": "/functions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#ListFunctionsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of functions that you want MediaTailor to return in response to the current request. If there are more than MaxResults functions, use the value of NextToken in the response to get the next page of results.
The default value is 100. MediaTailor uses token-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
For the first ListFunctions request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.
A list of functions associated with your account in the current Region.
" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
For the first ListFunctions request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.
Lists the live sources contained in a source location. A source represents a piece of content.
", "smithy.api#http": { "method": "GET", "uri": "/sourceLocation/{SourceLocationName}/liveSources", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#ListLiveSourcesRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { "smithy.api#documentation": "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.
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
For the first ListLiveSources request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.
The name of the source location associated with this Live Sources list.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#ListLiveSourcesResponse": { "type": "structure", "members": { "Items": { "target": "com.amazonaws.mediatailor#__listOfLiveSource", "traits": { "smithy.api#documentation": "Lists the live sources.
" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" } } } }, "com.amazonaws.mediatailor#ListPlaybackConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#ListPlaybackConfigurationsRequest" }, "output": { "target": "com.amazonaws.mediatailor#ListPlaybackConfigurationsResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the list of available configurations", "relativeDocumentation": "playbackconfigurations.html" }, "smithy.api#documentation": "Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.
", "smithy.api#http": { "method": "GET", "uri": "/playbackConfigurations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#ListPlaybackConfigurationsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { "smithy.api#documentation": "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.
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
For the first ListPlaybackConfigurations request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.
Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.
" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" } } } }, "com.amazonaws.mediatailor#ListPrefetchScheduleType": { "type": "enum", "members": { "SINGLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SINGLE" } }, "RECURRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECURRING" } }, "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } } } }, "com.amazonaws.mediatailor#ListPrefetchSchedules": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#ListPrefetchSchedulesRequest" }, "output": { "target": "com.amazonaws.mediatailor#ListPrefetchSchedulesResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the list of prefetch schedules for a playback configuration", "relativeDocumentation": "prefetchschedule-playbackconfigurationname.html", "resources": { "required": { "playbackConfiguration": {} } } }, "smithy.api#documentation": "Lists the prefetch schedules for a playback configuration.
", "smithy.api#http": { "method": "POST", "uri": "/prefetchSchedule/{PlaybackConfigurationName}", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" }, "smithy.api#readonly": {}, "smithy.api#suppress": [ "HttpMethodSemantics" ] } }, "com.amazonaws.mediatailor#ListPrefetchSchedulesRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.mediatailor#__integerMin1Max100", "traits": { "smithy.api#documentation": "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.
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
For the first ListPrefetchSchedules request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.
Retrieves the prefetch schedule(s) for a specific playback configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ScheduleType": { "target": "com.amazonaws.mediatailor#ListPrefetchScheduleType", "traits": { "smithy.api#documentation": "The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.
An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.
" } } } }, "com.amazonaws.mediatailor#ListPrefetchSchedulesResponse": { "type": "structure", "members": { "Items": { "target": "com.amazonaws.mediatailor#__listOfPrefetchSchedule", "traits": { "smithy.api#documentation": "Lists the prefetch schedules. An empty Items list doesn't mean there aren't more items to fetch, just that that page was empty.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" } } } }, "com.amazonaws.mediatailor#ListSourceLocations": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#ListSourceLocationsRequest" }, "output": { "target": "com.amazonaws.mediatailor#ListSourceLocationsResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the list of existing source locations", "relativeDocumentation": "sourcelocations.html" }, "smithy.api#documentation": "Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.
", "smithy.api#http": { "method": "GET", "uri": "/sourceLocations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#ListSourceLocationsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { "smithy.api#documentation": " 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.
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
For the first ListSourceLocations request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.
A list of source locations.
" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" } } } }, "com.amazonaws.mediatailor#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.mediatailor#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.mediatailor#BadRequestException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list the tags assigned to the specified playback configuration resource", "relativeDocumentation": "tags-resourcearn.html", "resources": { "optional": { "playbackConfiguration": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] }, "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] }, "sourceLocation": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] }, "vodSource": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] }, "liveSource": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] }, "function": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with this resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags 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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#ListVodSources": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#ListVodSourcesRequest" }, "output": { "target": "com.amazonaws.mediatailor#ListVodSourcesResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve the list of existing VOD sources on the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname-vodsources.html" }, "smithy.api#documentation": "Lists the VOD sources contained in a source location. A source represents a piece of content.
", "smithy.api#http": { "method": "GET", "uri": "/sourceLocation/{SourceLocationName}/vodSources", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Items", "pageSize": "MaxResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.mediatailor#ListVodSourcesRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { "smithy.api#documentation": " 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.
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
For the first ListVodSources request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.
The name of the source location associated with this VOD Source list.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#ListVodSourcesResponse": { "type": "structure", "members": { "Items": { "target": "com.amazonaws.mediatailor#__listOfVodSource", "traits": { "smithy.api#documentation": "Lists the VOD sources.
" } }, "NextToken": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" } } } }, "com.amazonaws.mediatailor#LivePreRollConfiguration": { "type": "structure", "members": { "AdDecisionServerUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
" } }, "MaxDurationSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "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.
" } }, "AdDecisionServerConfiguration": { "target": "com.amazonaws.mediatailor#PreRollAdDecisionServerConfiguration", "traits": { "smithy.api#documentation": "The configuration for the ad decision server (ADS) for live pre-roll ads. The configuration contains settings that control how MediaTailor processes VAST responses for pre-roll ad breaks.
" } } }, "traits": { "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" } }, "com.amazonaws.mediatailor#LiveSource": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN for the live source.
", "smithy.api#required": {} } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the live source was created.
" } }, "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "The HTTP package configurations for the live source.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the live source was last modified.
" } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name that's used to refer to a live source.
", "smithy.api#required": {} } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned 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.
", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#documentation": "Live source configuration parameters.
", "smithy.api#references": [ { "resource": "com.amazonaws.mediatailor#LiveSourceResource" } ] } }, "com.amazonaws.mediatailor#LiveSourceResource": { "type": "resource", "identifiers": { "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string" }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string" } }, "put": { "target": "com.amazonaws.mediatailor#CreateLiveSource" }, "read": { "target": "com.amazonaws.mediatailor#DescribeLiveSource" }, "update": { "target": "com.amazonaws.mediatailor#UpdateLiveSource" }, "delete": { "target": "com.amazonaws.mediatailor#DeleteLiveSource" }, "list": { "target": "com.amazonaws.mediatailor#ListLiveSources" }, "traits": { "aws.api#arn": { "template": "liveSource/{SourceLocationName}/{LiveSourceName}" }, "aws.api#taggable": {}, "aws.cloudformation#cfnResource": { "name": "LiveSource" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "liveSource", "relativeDocumentation": "sourcelocation-sourcelocationname-livesource-livesourcename.html" }, "smithy.api#documentation": "Represents a single live stream that can be added to a source location", "smithy.api#unstable": {} } }, "com.amazonaws.mediatailor#LogConfiguration": { "type": "structure", "members": { "PercentEnabled": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The percentage of session logs that MediaTailor sends to your configured log destination. 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
The method used for collecting logs from AWS Elemental MediaTailor. LEGACY_CLOUDWATCH indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. VENDED_LOGS indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.
Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).
" } }, "ManifestServiceInteractionLog": { "target": "com.amazonaws.mediatailor#ManifestServiceInteractionLog", "traits": { "smithy.api#documentation": "Settings for customizing what events are included in logs for interactions with the origin server.
" } } }, "traits": { "smithy.api#documentation": "Defines where AWS Elemental MediaTailor sends logs for the playback configuration.
" } }, "com.amazonaws.mediatailor#LogConfigurationForChannel": { "type": "structure", "members": { "LogTypes": { "target": "com.amazonaws.mediatailor#LogTypes", "traits": { "smithy.api#documentation": "The log types.
" } } }, "traits": { "smithy.api#documentation": "The log configuration for the channel.
" } }, "com.amazonaws.mediatailor#LogType": { "type": "enum", "members": { "AS_RUN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AS_RUN" } } } }, "com.amazonaws.mediatailor#LogTypes": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#LogType" } }, "com.amazonaws.mediatailor#LoggingStrategy": { "type": "enum", "members": { "VENDED_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VENDED_LOGS" } }, "LEGACY_CLOUDWATCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LEGACY_CLOUDWATCH" } } } }, "com.amazonaws.mediatailor#ManifestProcessingRules": { "type": "structure", "members": { "AdMarkerPassthrough": { "target": "com.amazonaws.mediatailor#AdMarkerPassthrough", "traits": { "smithy.api#documentation": "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.
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" } }, "com.amazonaws.mediatailor#ManifestServiceExcludeEventType": { "type": "enum", "members": { "GENERATED_MANIFEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GENERATED_MANIFEST" } }, "ORIGIN_MANIFEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORIGIN_MANIFEST" } }, "SESSION_INITIALIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SESSION_INITIALIZED" } }, "TRACKING_RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRACKING_RESPONSE" } }, "CONFIG_SYNTAX_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONFIG_SYNTAX_ERROR" } }, "CONFIG_SECURITY_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONFIG_SECURITY_ERROR" } }, "UNKNOWN_HOST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN_HOST" } }, "TIMEOUT_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIMEOUT_ERROR" } }, "CONNECTION_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONNECTION_ERROR" } }, "IO_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IO_ERROR" } }, "UNKNOWN_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN_ERROR" } }, "HOST_DISALLOWED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOST_DISALLOWED" } }, "PARSING_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARSING_ERROR" } }, "MANIFEST_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANIFEST_ERROR" } }, "NO_MASTER_OR_MEDIA_PLAYLIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_MASTER_OR_MEDIA_PLAYLIST" } }, "NO_MASTER_PLAYLIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_MASTER_PLAYLIST" } }, "NO_MEDIA_PLAYLIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_MEDIA_PLAYLIST" } }, "INCOMPATIBLE_HLS_VERSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INCOMPATIBLE_HLS_VERSION" } }, "SCTE35_PARSING_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCTE35_PARSING_ERROR" } }, "INVALID_SINGLE_PERIOD_DASH_MANIFEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_SINGLE_PERIOD_DASH_MANIFEST" } }, "UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST" } }, "LAST_PERIOD_MISSING_AUDIO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LAST_PERIOD_MISSING_AUDIO" } }, "LAST_PERIOD_MISSING_AUDIO_WARNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LAST_PERIOD_MISSING_AUDIO_WARNING" } }, "ERROR_ORIGIN_PREFIX_INTERPOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_ORIGIN_PREFIX_INTERPOLATION" } }, "ERROR_ADS_INTERPOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_ADS_INTERPOLATION" } }, "ERROR_LIVE_PRE_ROLL_ADS_INTERPOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_LIVE_PRE_ROLL_ADS_INTERPOLATION" } }, "ERROR_CDN_AD_SEGMENT_INTERPOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_CDN_AD_SEGMENT_INTERPOLATION" } }, "ERROR_CDN_CONTENT_SEGMENT_INTERPOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_CDN_CONTENT_SEGMENT_INTERPOLATION" } }, "ERROR_SLATE_AD_URL_INTERPOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_SLATE_AD_URL_INTERPOLATION" } }, "ERROR_PROFILE_NAME_INTERPOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_PROFILE_NAME_INTERPOLATION" } }, "ERROR_BUMPER_START_INTERPOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_BUMPER_START_INTERPOLATION" } }, "ERROR_BUMPER_END_INTERPOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR_BUMPER_END_INTERPOLATION" } }, "PRE_SESSION_INIT_HOOK_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_SESSION_INIT_HOOK_ERROR" } }, "PRE_SESSION_INIT_FUNCTION_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_SESSION_INIT_FUNCTION_ERROR" } }, "POST_ORIGIN_RESPONSE_HOOK_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST_ORIGIN_RESPONSE_HOOK_ERROR" } }, "POST_ORIGIN_RESPONSE_FUNCTION_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST_ORIGIN_RESPONSE_FUNCTION_ERROR" } } } }, "com.amazonaws.mediatailor#ManifestServiceInteractionLog": { "type": "structure", "members": { "PublishOptInEventTypes": { "target": "com.amazonaws.mediatailor#__manifestServicePublishOptInEventTypesList", "traits": { "smithy.api#documentation": "Indicates that MediaTailor will emit the selected events in the logs for playback sessions that are initialized with this configuration. These events are not emitted by default and must be explicitly opted in.
" } }, "ExcludeEventTypes": { "target": "com.amazonaws.mediatailor#__manifestServiceExcludeEventTypesList", "traits": { "smithy.api#documentation": "Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.mediatailor#ManifestServicePublishOptInEventType": { "type": "enum", "members": { "PRE_SESSION_INIT_HOOK_SUMMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_SESSION_INIT_HOOK_SUMMARY" } }, "PRE_SESSION_INIT_FUNCTION_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE_SESSION_INIT_FUNCTION_COMPLETED" } }, "POST_ORIGIN_RESPONSE_HOOK_SUMMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST_ORIGIN_RESPONSE_HOOK_SUMMARY" } }, "POST_ORIGIN_RESPONSE_FUNCTION_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST_ORIGIN_RESPONSE_FUNCTION_COMPLETED" } } } }, "com.amazonaws.mediatailor#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.mediatailor#MediaTailor": { "type": "service", "version": "2018-04-23", "operations": [ { "target": "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfiguration" }, { "target": "com.amazonaws.mediatailor#ListAlerts" }, { "target": "com.amazonaws.mediatailor#ListTagsForResource" }, { "target": "com.amazonaws.mediatailor#TagResource" }, { "target": "com.amazonaws.mediatailor#UntagResource" } ], "resources": [ { "target": "com.amazonaws.mediatailor#ChannelResource" }, { "target": "com.amazonaws.mediatailor#FunctionResource" }, { "target": "com.amazonaws.mediatailor#LiveSourceResource" }, { "target": "com.amazonaws.mediatailor#PlaybackConfigurationResource" }, { "target": "com.amazonaws.mediatailor#PrefetchScheduleResource" }, { "target": "com.amazonaws.mediatailor#SourceLocationResource" }, { "target": "com.amazonaws.mediatailor#VodSourceResource" } ], "traits": { "aws.api#service": { "sdkId": "MediaTailor", "arnNamespace": "mediatailor", "cloudFormationName": "MediaTailor", "cloudTrailEventSource": "mediatailor.amazonaws.com", "endpointPrefix": "api.mediatailor" }, "aws.api#tagEnabled": {}, "aws.auth#sigv4": { "name": "mediatailor" }, "aws.endpoints#standardRegionalEndpoints": { "partitionSpecialCases": { "aws": [ { "endpoint": "https://mediatailor.{region}.{dualStackDnsSuffix}", "dualStack": true } ] } }, "aws.iam#defineConditionKeys": { "aws:ResourceTag/${TagKey}": { "type": "String", "documentation": "Filters access by tag key-value pairs attached to the resource", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" }, "aws:RequestTag/${TagKey}": { "type": "String", "documentation": "Filters access by the presence of tag key-value pairs in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" }, "aws:TagKeys": { "type": "ArrayOfString", "documentation": "Filters access by the presence of tag keys in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" } }, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "*", "Authorization", "Date", "X-Amz-Date", "X-Amz-Security-Token", "X-Amz-Target", "content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", "x-amzn-trace-id" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-errormessage", "x-amzn-trace-id", "x-amz-apigw-id", "date" ], "maxAge": 86400 }, "smithy.api#documentation": "Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.
Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).
", "smithy.api#title": "AWS MediaTailor", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://mediatailor.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.mediatailor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://api.mediatailor-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://api.mediatailor.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://api.mediatailor.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAkAAAAGAAAABQAAAAcF9eELAAAABgX14QQAAAAIAAAABwX14QkF9eEKAAAABAAAAAsAAAAKAAAABQX14QYF9eEIAAAABQAAAAwF9eEHAAAABwX14QUF9eEGAAAAAwX14QEAAAAOAAAABQX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://mediatailor.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://api.mediatailor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://api.mediatailor-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://api.mediatailor.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://api.mediatailor.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://mediatailor.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.mediatailor.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.mediatailor.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.mediatailor.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.mediatailor#MessageType": { "type": "enum", "members": { "SPLICE_INSERT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPLICE_INSERT" } }, "TIME_SIGNAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIME_SIGNAL" } } } }, "com.amazonaws.mediatailor#Method": { "type": "enum", "members": { "GET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GET" } }, "POST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST" } } } }, "com.amazonaws.mediatailor#MethodType": { "type": "enum", "members": { "GET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GET" } }, "POST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST" } } } }, "com.amazonaws.mediatailor#MinimumUnfilledDurationSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 6, "max": 3600 } } }, "com.amazonaws.mediatailor#Mode": { "type": "enum", "members": { "OFF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFF" } }, "BEHIND_LIVE_EDGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEHIND_LIVE_EDGE" } }, "AFTER_LIVE_EDGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_LIVE_EDGE" } } } }, "com.amazonaws.mediatailor#OpenRtbTemplateString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 102400 } } }, "com.amazonaws.mediatailor#Operator": { "type": "enum", "members": { "EQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EQUALS" } } } }, "com.amazonaws.mediatailor#OriginManifestType": { "type": "enum", "members": { "SINGLE_PERIOD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SINGLE_PERIOD" } }, "MULTI_PERIOD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MULTI_PERIOD" } } } }, "com.amazonaws.mediatailor#PlaybackConfiguration": { "type": "structure", "members": { "AdDecisionServerUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#AvailSuppression", "traits": { "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" } }, "Bumper": { "target": "com.amazonaws.mediatailor#Bumper", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#CdnConfiguration", "traits": { "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" } }, "ConfigurationAliases": { "target": "com.amazonaws.mediatailor#ConfigurationAliasesResponse", "traits": { "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" } }, "DashConfiguration": { "target": "com.amazonaws.mediatailor#DashConfiguration", "traits": { "smithy.api#documentation": "The configuration for a DASH source.
" } }, "HlsConfiguration": { "target": "com.amazonaws.mediatailor#HlsConfiguration", "traits": { "smithy.api#documentation": "The configuration for HLS content.
" } }, "InsertionMode": { "target": "com.amazonaws.mediatailor#InsertionMode", "traits": { "smithy.api#default": "STITCHED_ONLY", "smithy.api#documentation": "The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT 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.
The configuration for pre-roll ad insertion.
" } }, "LogConfiguration": { "target": "com.amazonaws.mediatailor#LogConfiguration", "traits": { "smithy.api#documentation": "Defines where AWS Elemental MediaTailor sends logs for the playback configuration.
" } }, "ManifestProcessingRules": { "target": "com.amazonaws.mediatailor#ManifestProcessingRules", "traits": { "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" } }, "Name": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier for the playback configuration.
" } }, "PersonalizationThresholdSeconds": { "target": "com.amazonaws.mediatailor#__integerMin1", "traits": { "smithy.api#documentation": "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.
" } }, "PlaybackConfigurationArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the playback configuration.
" } }, "PlaybackEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL that your player accesses to get a manifest from AWS Elemental MediaTailor.
" } }, "DualStackPlaybackEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dual-stack (IPv4 and IPv6) URL that your player accesses to get a manifest from AWS Elemental MediaTailor.
" } }, "SessionInitializationEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL that your player uses to initialize a session that uses client-side reporting.
" } }, "DualStackSessionInitializationEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dual-stack (IPv4 and IPv6) URL that your player uses to initialize a session that uses client-side reporting.
" } }, "SlateAdUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } }, "TranscodeProfileName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" } }, "AdConditioningConfiguration": { "target": "com.amazonaws.mediatailor#AdConditioningConfiguration", "traits": { "smithy.api#documentation": "The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.
" } }, "AdDecisionServerConfiguration": { "target": "com.amazonaws.mediatailor#AdDecisionServerConfiguration" }, "YieldOptimizationConfiguration": { "target": "com.amazonaws.mediatailor#YieldOptimizationConfiguration", "traits": { "smithy.api#documentation": "Configuration for Yield Optimization, which fills unsold ad inventory in ad breaks with programmatic ads from Amazon Publisher Services (APS).
" } }, "FunctionMapping": { "target": "com.amazonaws.mediatailor#FunctionMapping", "traits": { "smithy.api#documentation": "A map of lifecycle hook event names to function identifiers. The function mapping specifies which function MediaTailor executes at each lifecycle hook during ad insertion. Valid keys are PRE_SESSION_INITIALIZATION, POST_ORIGIN_RESPONSE, PRE_ADS_REQUEST, POST_ADS_RESPONSE, and PRE_MANIFEST_INSERTION. For more information, see Functions lifecycle hooks in the MediaTailor User Guide.
The timeout settings for ad decision server interactions. These settings control how long MediaTailor waits for ADS responses and the total time budget for ad personalization across live, VOD, and prefetch workflows.
" } }, "AdsPersonalizationConcurrency": { "target": "com.amazonaws.mediatailor#AdsPersonalizationConcurrency", "traits": { "smithy.api#documentation": "The concurrency settings for ad decision server interactions. These settings control how many simultaneous ADS requests MediaTailor makes per manifest request.
" } }, "BeaconingConfiguration": { "target": "com.amazonaws.mediatailor#BeaconingConfiguration", "traits": { "smithy.api#documentation": "The beaconing configuration for this playback configuration, which controls whether MediaTailor includes beacons of its own in the ad tracking response.
" } } }, "traits": { "smithy.api#documentation": "A playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", "smithy.api#references": [ { "resource": "com.amazonaws.mediatailor#PlaybackConfigurationResource" } ] } }, "com.amazonaws.mediatailor#PlaybackConfigurationResource": { "type": "resource", "identifiers": { "Name": { "target": "com.amazonaws.mediatailor#__string" } }, "put": { "target": "com.amazonaws.mediatailor#PutPlaybackConfiguration" }, "read": { "target": "com.amazonaws.mediatailor#GetPlaybackConfiguration" }, "delete": { "target": "com.amazonaws.mediatailor#DeletePlaybackConfiguration" }, "list": { "target": "com.amazonaws.mediatailor#ListPlaybackConfigurations" }, "traits": { "aws.api#arn": { "template": "playbackConfiguration/{Name}" }, "aws.api#taggable": {}, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "playbackConfiguration", "relativeDocumentation": "playbackconfiguration.html" }, "smithy.api#documentation": "Represents a configuration with mapping information for the origin server and the ad decision server (ADS)" } }, "com.amazonaws.mediatailor#PlaybackMode": { "type": "enum", "members": { "LOOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOOP" } }, "LINEAR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LINEAR" } } } }, "com.amazonaws.mediatailor#PreRollAdDecisionServerConfiguration": { "type": "structure", "members": { "VastResponse": { "target": "com.amazonaws.mediatailor#PreRollVastResponse", "traits": { "smithy.api#documentation": "The settings that control how MediaTailor processes VAST responses for live pre-roll ad breaks.
" } } }, "traits": { "smithy.api#documentation": "The ad decision server configuration for live pre-roll ads. It contains settings that control how MediaTailor processes VAST responses for pre-roll ad breaks.
" } }, "com.amazonaws.mediatailor#PreRollAdSequencingMode": { "type": "enum", "members": { "FOLLOW_AD_SEQUENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FOLLOW_AD_SEQUENCE" } }, "IGNORE_AD_SEQUENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IGNORE_AD_SEQUENCE" } } } }, "com.amazonaws.mediatailor#PreRollVastResponse": { "type": "structure", "members": { "AdSequencingMode": { "target": "com.amazonaws.mediatailor#PreRollAdSequencingMode", "traits": { "smithy.api#documentation": "The ad sequencing mode for live pre-roll ads. FOLLOW_AD_SEQUENCE inserts sequenced ads in increasing order and uses standalone ads only as replacements when a sequenced ad fails. IGNORE_AD_SEQUENCE inserts ads in the order they appear in the VAST response, regardless of sequence attributes. The default behavior is IGNORE_AD_SEQUENCE.
The settings that control how MediaTailor processes VAST responses from the ad decision server for live pre-roll ad breaks.
" } }, "com.amazonaws.mediatailor#PrefetchConsumption": { "type": "structure", "members": { "AvailMatchingCriteria": { "target": "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria", "traits": { "smithy.api#documentation": "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.
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.
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 retrieves them from the ad decision server.
For single prefetch, describes how and when that MediaTailor places prefetched ads into upcoming ad breaks.
" } }, "com.amazonaws.mediatailor#PrefetchRetrieval": { "type": "structure", "members": { "DynamicVariables": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You initially configure dynamic variables 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.
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "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.
" } }, "TrafficShapingType": { "target": "com.amazonaws.mediatailor#TrafficShapingType", "traits": { "smithy.api#documentation": "Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.
" } }, "TrafficShapingRetrievalWindow": { "target": "com.amazonaws.mediatailor#TrafficShapingRetrievalWindow", "traits": { "smithy.api#documentation": "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.
" } }, "TrafficShapingTpsConfiguration": { "target": "com.amazonaws.mediatailor#TrafficShapingTpsConfiguration", "traits": { "smithy.api#documentation": "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.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.mediatailor#PrefetchSchedule": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prefetch schedule.
", "smithy.api#required": {} } }, "Consumption": { "target": "com.amazonaws.mediatailor#PrefetchConsumption", "traits": { "smithy.api#documentation": "Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks for single prefetch schedules. 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.
" } }, "Name": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
", "smithy.api#required": {} } }, "PlaybackConfigurationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the playback configuration to create the prefetch schedule for.
", "smithy.api#required": {} } }, "Retrieval": { "target": "com.amazonaws.mediatailor#PrefetchRetrieval", "traits": { "smithy.api#documentation": "A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
" } }, "ScheduleType": { "target": "com.amazonaws.mediatailor#PrefetchScheduleType", "traits": { "smithy.api#documentation": "The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.
For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.
" } }, "RecurringPrefetchConfiguration": { "target": "com.amazonaws.mediatailor#RecurringPrefetchConfiguration", "traits": { "smithy.api#documentation": "The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.
" } }, "StreamId": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned to the prefetch schedule. 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.
", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#documentation": "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.
", "smithy.api#references": [ { "resource": "com.amazonaws.mediatailor#PrefetchScheduleResource" } ] } }, "com.amazonaws.mediatailor#PrefetchScheduleResource": { "type": "resource", "identifiers": { "Name": { "target": "com.amazonaws.mediatailor#__string" }, "PlaybackConfigurationName": { "target": "com.amazonaws.mediatailor#__string" } }, "put": { "target": "com.amazonaws.mediatailor#CreatePrefetchSchedule" }, "read": { "target": "com.amazonaws.mediatailor#GetPrefetchSchedule" }, "delete": { "target": "com.amazonaws.mediatailor#DeletePrefetchSchedule" }, "list": { "target": "com.amazonaws.mediatailor#ListPrefetchSchedules" }, "traits": { "aws.api#arn": { "template": "prefetchSchedule/{PlaybackConfigurationName}/{Name}" }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "prefetchSchedule", "relativeDocumentation": "prefetchschedule-playbackconfigurationname-name.html" }, "smithy.api#documentation": "Represents a configuration that is used to fetch and prepare ads in advance of the ad break.", "smithy.api#noReplace": {} } }, "com.amazonaws.mediatailor#PrefetchScheduleType": { "type": "enum", "members": { "SINGLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SINGLE" } }, "RECURRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECURRING" } } } }, "com.amazonaws.mediatailor#ProgramResource": { "type": "resource", "identifiers": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string" }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string" } }, "put": { "target": "com.amazonaws.mediatailor#CreateProgram" }, "read": { "target": "com.amazonaws.mediatailor#DescribeProgram" }, "update": { "target": "com.amazonaws.mediatailor#UpdateProgram" }, "delete": { "target": "com.amazonaws.mediatailor#DeleteProgram" }, "traits": { "aws.api#arn": { "template": "program/{ChannelName}/{ProgramName}" }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "program", "relativeDocumentation": "channel-channelname-program-programname.html", "disableConditionKeyInheritance": true }, "smithy.api#documentation": "Represents a piece of content scheduled on a channel", "smithy.api#noReplace": {} } }, "com.amazonaws.mediatailor#PutChannelPolicy": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#PutChannelPolicyRequest" }, "output": { "target": "com.amazonaws.mediatailor#PutChannelPolicyResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to set the IAM policy on the channel with the specified channel name", "relativeDocumentation": "channel-channelname-policy.html", "resources": { "required": { "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Creates an IAM policy for the channel. IAM policies are used to control access to your channel.
", "smithy.api#http": { "method": "PUT", "uri": "/channel/{ChannelName}/policy", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#PutChannelPolicyRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The channel name associated with this Channel Policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.mediatailor#__string", "traits": { "aws.api#data": "permissions", "smithy.api#documentation": "Adds an IAM role that determines the permissions of your channel.
", "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#PutChannelPolicyResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#PutFunction": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#PutFunctionRequest" }, "output": { "target": "com.amazonaws.mediatailor#PutFunctionResponse" }, "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "smithy.api#documentation": "Creates or updates a function. A function defines reusable logic that MediaTailor executes at lifecycle hooks during ad insertion. For more information about functions, see Working with functions in the MediaTailor User Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/function/{FunctionId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#PutFunctionRequest": { "type": "structure", "members": { "FunctionId": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier of the function. The identifier must be unique within your account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "FunctionType": { "target": "com.amazonaws.mediatailor#FunctionType", "traits": { "smithy.api#documentation": "The type of the function, which determines what the function can do at runtime. Valid values:
CUSTOM_OUTPUT \u2013 Evaluates expressions and produces output bindings with no external calls.
HTTP_REQUEST \u2013 Makes an HTTP call to an external service and evaluates output expressions that can reference the response.
AWS_SERVICE_REQUEST \u2013 Makes an authenticated request to a supported AWS service API and evaluates output expressions that can reference the response.
HLS_TAG_PROCESSOR \u2013 Reads and changes HLS tags in the origin manifest at the POST_ORIGIN_RESPONSE lifecycle hook.
VAST_REQUEST \u2013 Calls a VAST endpoint, parses the response as VAST, and makes the parsed ads available to output expressions.
SEQUENTIAL_EXECUTOR \u2013 Runs a sequence of child functions in order, passing data between steps through temporary data.
CONCURRENT_EXECUTOR \u2013 Runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete.
For more information, see Function types and composition in the MediaTailor User Guide.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "A description of the function.
" } }, "HttpRequestConfiguration": { "target": "com.amazonaws.mediatailor#HttpRequestConfiguration", "traits": { "smithy.api#documentation": "The configuration for an HTTP_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions. Required when FunctionType is HTTP_REQUEST.
The configuration for an AWS_SERVICE_REQUEST function. You must specify this parameter when FunctionType is AWS_SERVICE_REQUEST.
The configuration for a CUSTOM_OUTPUT function. Specifies the runtime and output expressions. Required when FunctionType is CUSTOM_OUTPUT.
The configuration for a CONCURRENT_EXECUTOR function. Specifies the list of child functions to run in parallel, the maximum concurrency, an optional output block, and a timeout. Required when FunctionType is CONCURRENT_EXECUTOR.
The configuration for a SEQUENTIAL_EXECUTOR function. Specifies the ordered list of child functions to execute, an optional output block, and a timeout. Required when FunctionType is SEQUENTIAL_EXECUTOR.
The configuration for a VAST_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions. Required when FunctionType is VAST_REQUEST.
The configuration for an HLS_TAG_PROCESSOR function. Specifies the runtime, tag filter, optional run condition, and output expressions. Required when FunctionType is HLS_TAG_PROCESSOR.
The tags to assign to the function. 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.
", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#documentation": "-- Define Mixin --", "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.mediatailor#FunctionResource" } ] } }, "com.amazonaws.mediatailor#PutFunctionResponse": { "type": "structure", "members": { "FunctionId": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier of the function.
", "smithy.api#required": {} } }, "FunctionType": { "target": "com.amazonaws.mediatailor#FunctionType", "traits": { "smithy.api#documentation": "The type of the function.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "A description of the function.
" } }, "HttpRequestConfiguration": { "target": "com.amazonaws.mediatailor#HttpRequestConfiguration", "traits": { "smithy.api#documentation": "The configuration for an HTTP_REQUEST function.
The configuration for an AWS_SERVICE_REQUEST function. Specifies the target service, target Region, and request parameters.
The configuration for a CUSTOM_OUTPUT function.
The configuration for a CONCURRENT_EXECUTOR function.
The configuration for a SEQUENTIAL_EXECUTOR function.
The configuration for a VAST_REQUEST function.
The configuration for an HLS_TAG_PROCESSOR function.
The tags assigned to the function. 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.
", "smithy.api#jsonName": "tags" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function.
" } } }, "traits": { "smithy.api#documentation": "-- Define Mixin --", "smithy.api#output": {} } }, "com.amazonaws.mediatailor#PutPlaybackConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#PutPlaybackConfigurationRequest" }, "output": { "target": "com.amazonaws.mediatailor#PutPlaybackConfigurationResponse" }, "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to add a new configuration", "relativeDocumentation": "playbackconfiguration.html", "createsResources": [ "playbackConfiguration" ], "resources": { "required": { "playbackConfiguration": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ] } } } }, "smithy.api#documentation": "Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", "smithy.api#http": { "method": "PUT", "uri": "/playbackConfiguration", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#PutPlaybackConfigurationRequest": { "type": "structure", "members": { "AdDecisionServerUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#AvailSuppression", "traits": { "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" } }, "Bumper": { "target": "com.amazonaws.mediatailor#Bumper", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#CdnConfiguration", "traits": { "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" } }, "ConfigurationAliases": { "target": "com.amazonaws.mediatailor#ConfigurationAliasesRequest", "traits": { "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" } }, "DashConfiguration": { "target": "com.amazonaws.mediatailor#DashConfigurationForPut", "traits": { "smithy.api#documentation": "The configuration for DASH content.
" } }, "InsertionMode": { "target": "com.amazonaws.mediatailor#InsertionMode", "traits": { "smithy.api#default": "STITCHED_ONLY", "smithy.api#documentation": "The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT 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.
The configuration for pre-roll ad insertion.
" } }, "ManifestProcessingRules": { "target": "com.amazonaws.mediatailor#ManifestProcessingRules", "traits": { "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" } }, "Name": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier for the playback configuration.
", "smithy.api#required": {} } }, "PersonalizationThresholdSeconds": { "target": "com.amazonaws.mediatailor#__integerMin1", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } }, "TranscodeProfileName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" } }, "AdConditioningConfiguration": { "target": "com.amazonaws.mediatailor#AdConditioningConfiguration", "traits": { "smithy.api#documentation": "The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.
" } }, "AdDecisionServerConfiguration": { "target": "com.amazonaws.mediatailor#AdDecisionServerConfiguration", "traits": { "smithy.api#documentation": "The configuration for customizing HTTP requests to the ad decision server (ADS). This includes settings for request method, headers, body content, and compression options.
" } }, "YieldOptimizationConfiguration": { "target": "com.amazonaws.mediatailor#YieldOptimizationConfiguration", "traits": { "smithy.api#documentation": "Configuration for Yield Optimization, which fills unsold ad inventory in ad breaks with programmatic ads from Amazon Publisher Services (APS).
" } }, "FunctionMapping": { "target": "com.amazonaws.mediatailor#FunctionMapping", "traits": { "smithy.api#documentation": "A map of lifecycle hook event names to function identifiers. The function mapping specifies which function MediaTailor executes at each lifecycle hook during ad insertion. Valid keys are PRE_SESSION_INITIALIZATION, POST_ORIGIN_RESPONSE, PRE_ADS_REQUEST, POST_ADS_RESPONSE, and PRE_MANIFEST_INSERTION. For more information, see Functions lifecycle hooks in the MediaTailor User Guide.
The timeout settings for ad decision server interactions. These settings control how long MediaTailor waits for ADS responses and the total time budget for ad personalization across live, VOD, and prefetch workflows.
" } }, "AdsPersonalizationConcurrency": { "target": "com.amazonaws.mediatailor#AdsPersonalizationConcurrency", "traits": { "smithy.api#documentation": "The concurrency settings for ad decision server interactions. These settings control how many simultaneous ADS requests MediaTailor makes per manifest request.
" } }, "BeaconingConfiguration": { "target": "com.amazonaws.mediatailor#BeaconingConfiguration", "traits": { "smithy.api#documentation": "The beaconing configuration for this playback configuration, which controls whether MediaTailor includes beacons of its own in the ad tracking response. If you omit this setting, MediaTailor uses INSIGHTS.
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": { "target": "com.amazonaws.mediatailor#AvailSuppression", "traits": { "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" } }, "Bumper": { "target": "com.amazonaws.mediatailor#Bumper", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#CdnConfiguration", "traits": { "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" } }, "ConfigurationAliases": { "target": "com.amazonaws.mediatailor#ConfigurationAliasesResponse", "traits": { "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" } }, "DashConfiguration": { "target": "com.amazonaws.mediatailor#DashConfiguration", "traits": { "smithy.api#documentation": "The configuration for DASH content.
" } }, "HlsConfiguration": { "target": "com.amazonaws.mediatailor#HlsConfiguration", "traits": { "smithy.api#documentation": "The configuration for HLS content.
" } }, "InsertionMode": { "target": "com.amazonaws.mediatailor#InsertionMode", "traits": { "smithy.api#default": "STITCHED_ONLY", "smithy.api#documentation": "The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT 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.
The configuration for pre-roll ad insertion.
" } }, "LogConfiguration": { "target": "com.amazonaws.mediatailor#LogConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.
" } }, "ManifestProcessingRules": { "target": "com.amazonaws.mediatailor#ManifestProcessingRules", "traits": { "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" } }, "Name": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The identifier for the playback configuration.
" } }, "PersonalizationThresholdSeconds": { "target": "com.amazonaws.mediatailor#__integerMin1", "traits": { "smithy.api#documentation": "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.
" } }, "PlaybackConfigurationArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the playback configuration.
" } }, "PlaybackEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The playback endpoint prefix associated with the playback configuration.
" } }, "DualStackPlaybackEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dual-stack (IPv4 and IPv6) playback endpoint prefix associated with the playback configuration.
" } }, "SessionInitializationEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The session initialization endpoint prefix associated with the playback configuration.
" } }, "DualStackSessionInitializationEndpointPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dual-stack (IPv4 and IPv6) session initialization endpoint prefix associated with the playback configuration.
" } }, "SlateAdUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } }, "TranscodeProfileName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" } }, "AdConditioningConfiguration": { "target": "com.amazonaws.mediatailor#AdConditioningConfiguration", "traits": { "smithy.api#documentation": "The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.
" } }, "AdDecisionServerConfiguration": { "target": "com.amazonaws.mediatailor#AdDecisionServerConfiguration", "traits": { "smithy.api#documentation": "The configuration for customizing HTTP requests to the ad decision server (ADS). This includes settings for request method, headers, body content, and compression options.
" } }, "YieldOptimizationConfiguration": { "target": "com.amazonaws.mediatailor#YieldOptimizationConfiguration", "traits": { "smithy.api#documentation": "Configuration for Yield Optimization, which fills unsold ad inventory in ad breaks with programmatic ads from Amazon Publisher Services (APS).
" } }, "FunctionMapping": { "target": "com.amazonaws.mediatailor#FunctionMapping", "traits": { "smithy.api#documentation": "A map of lifecycle hook event names to function identifiers. The function mapping specifies which function MediaTailor executes at each lifecycle hook during ad insertion. Valid keys are PRE_SESSION_INITIALIZATION, POST_ORIGIN_RESPONSE, PRE_ADS_REQUEST, POST_ADS_RESPONSE, and PRE_MANIFEST_INSERTION. For more information, see Functions lifecycle hooks in the MediaTailor User Guide.
The timeout settings for ad decision server interactions. These settings control how long MediaTailor waits for ADS responses and the total time budget for ad personalization across live, VOD, and prefetch workflows.
" } }, "AdsPersonalizationConcurrency": { "target": "com.amazonaws.mediatailor#AdsPersonalizationConcurrency", "traits": { "smithy.api#documentation": "The concurrency settings for ad decision server interactions. These settings control how many simultaneous ADS requests MediaTailor makes per manifest request.
" } }, "BeaconingConfiguration": { "target": "com.amazonaws.mediatailor#BeaconingConfiguration", "traits": { "smithy.api#documentation": "The beaconing configuration for this playback configuration, which controls whether MediaTailor includes beacons of its own in the ad tracking response.
" } } } }, "com.amazonaws.mediatailor#RecurringConsumption": { "type": "structure", "members": { "RetrievedAdExpirationSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The number of seconds that an ad is available for insertion after it was prefetched.
" } }, "AvailMatchingCriteria": { "target": "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria", "traits": { "smithy.api#documentation": "The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.
" } } }, "traits": { "smithy.api#documentation": "The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.
" } }, "com.amazonaws.mediatailor#RecurringPrefetchConfiguration": { "type": "structure", "members": { "StartTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The start time for the window that MediaTailor prefetches and inserts ads in a live event.
" } }, "EndTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The end time for the window that MediaTailor prefetches and inserts ads in a live event.
", "smithy.api#required": {} } }, "RecurringConsumption": { "target": "com.amazonaws.mediatailor#RecurringConsumption", "traits": { "smithy.api#documentation": "The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.
", "smithy.api#required": {} } }, "RecurringRetrieval": { "target": "com.amazonaws.mediatailor#RecurringRetrieval", "traits": { "smithy.api#documentation": "The configuration for prefetch ad retrieval from the ADS.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The configuration that defines how MediaTailor performs recurring prefetch.
" } }, "com.amazonaws.mediatailor#RecurringRetrieval": { "type": "structure", "members": { "DynamicVariables": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The dynamic variables to use for substitution during prefetch requests to the ADS.
" } }, "DelayAfterAvailEndSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).
" } }, "TrafficShapingType": { "target": "com.amazonaws.mediatailor#TrafficShapingType", "traits": { "smithy.api#documentation": "Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.
" } }, "TrafficShapingRetrievalWindow": { "target": "com.amazonaws.mediatailor#TrafficShapingRetrievalWindow", "traits": { "smithy.api#documentation": "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.
" } }, "TrafficShapingTpsConfiguration": { "target": "com.amazonaws.mediatailor#TrafficShapingTpsConfiguration", "traits": { "smithy.api#documentation": "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.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.mediatailor#RelativePosition": { "type": "enum", "members": { "BEFORE_PROGRAM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEFORE_PROGRAM" } }, "AFTER_PROGRAM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_PROGRAM" } } } }, "com.amazonaws.mediatailor#RequestOutputItem": { "type": "structure", "members": { "DashPlaylistSettings": { "target": "com.amazonaws.mediatailor#DashPlaylistSettings", "traits": { "smithy.api#documentation": "DASH manifest configuration parameters.
" } }, "HlsPlaylistSettings": { "target": "com.amazonaws.mediatailor#HlsPlaylistSettings", "traits": { "smithy.api#documentation": "HLS playlist configuration parameters.
" } }, "ManifestName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the manifest for the channel. The name appears in the PlaybackUrl.
A string used to match which HttpPackageConfiguration is used for each VodSource.
The output configuration for this channel.
" } }, "com.amazonaws.mediatailor#RequestOutputs": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#RequestOutputItem" }, "traits": { "smithy.api#documentation": "An object that represents an object in the CreateChannel request.
" } }, "com.amazonaws.mediatailor#ResponseOutputItem": { "type": "structure", "members": { "DashPlaylistSettings": { "target": "com.amazonaws.mediatailor#DashPlaylistSettings", "traits": { "smithy.api#documentation": "DASH manifest configuration settings.
" } }, "HlsPlaylistSettings": { "target": "com.amazonaws.mediatailor#HlsPlaylistSettings", "traits": { "smithy.api#documentation": "HLS manifest configuration settings.
" } }, "ManifestName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the manifest for the channel that will appear in the channel output's playback URL.
", "smithy.api#required": {} } }, "PlaybackUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The URL that your player uses for playback.
", "smithy.api#required": {} } }, "DualStackPlaybackUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The dual-stack (IPv4 and IPv6) URL that your player uses for playback.
" } }, "SourceGroup": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "A string used to associate a package configuration source group with a channel output.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The output item response.
" } }, "com.amazonaws.mediatailor#ResponseOutputs": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#ResponseOutputItem" } }, "com.amazonaws.mediatailor#RuntimeType": { "type": "enum", "members": { "JSONATA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSONATA" } } } }, "com.amazonaws.mediatailor#ScheduleAdBreak": { "type": "structure", "members": { "ApproximateDurationSeconds": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#documentation": "The approximate duration of the ad break, in seconds.
" } }, "ApproximateStartTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The approximate time that the ad will start playing.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location containing the VOD source used for the ad break.
" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the VOD source used for the ad break.
" } } }, "traits": { "smithy.api#documentation": "The schedule's ad break properties.
" } }, "com.amazonaws.mediatailor#ScheduleConfiguration": { "type": "structure", "members": { "Transition": { "target": "com.amazonaws.mediatailor#Transition", "traits": { "smithy.api#documentation": "Program transition configurations.
", "smithy.api#required": {} } }, "ClipRange": { "target": "com.amazonaws.mediatailor#ClipRange", "traits": { "smithy.api#documentation": "Program clip range configuration.
" } } }, "traits": { "smithy.api#documentation": "Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.
" } }, "com.amazonaws.mediatailor#ScheduleEntry": { "type": "structure", "members": { "ApproximateDurationSeconds": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#documentation": "The approximate duration of this program, in seconds.
" } }, "ApproximateStartTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The approximate time that the program will start playing.
" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN of the program.
", "smithy.api#required": {} } }, "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel that uses this schedule.
", "smithy.api#required": {} } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the live source used for the program.
" } }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the program.
", "smithy.api#required": {} } }, "ScheduleAdBreaks": { "target": "com.amazonaws.mediatailor#__listOfScheduleAdBreak", "traits": { "smithy.api#documentation": "The schedule's ad break properties.
" } }, "ScheduleEntryType": { "target": "com.amazonaws.mediatailor#ScheduleEntryType", "traits": { "smithy.api#documentation": "The type of schedule entry.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location.
", "smithy.api#required": {} } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the VOD source.
" } }, "Audiences": { "target": "com.amazonaws.mediatailor#Audiences", "traits": { "smithy.api#documentation": "The list of audiences defined in ScheduleEntry.
" } } }, "traits": { "smithy.api#documentation": "The properties for a schedule.
" } }, "com.amazonaws.mediatailor#ScheduleEntryType": { "type": "enum", "members": { "PROGRAM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROGRAM" } }, "FILLER_SLATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FILLER_SLATE" } }, "ALTERNATE_MEDIA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALTERNATE_MEDIA" } } } }, "com.amazonaws.mediatailor#SecretsManagerAccessTokenConfiguration": { "type": "structure", "members": { "HeaderName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the HTTP header used to supply the access token in requests to the source location.
" } }, "SecretArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.
" } }, "SecretStringKey": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.
" } } }, "traits": { "smithy.api#documentation": "AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.
" } }, "com.amazonaws.mediatailor#SegmentDeliveryConfiguration": { "type": "structure", "members": { "BaseUrl": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.
A unique identifier used to distinguish between multiple segment delivery configurations in a source location.
" } } }, "traits": { "smithy.api#documentation": "The segment delivery configuration settings.
" } }, "com.amazonaws.mediatailor#SegmentationDescriptor": { "type": "structure", "members": { "SegmentationEventId": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is \"\" (an empty string).
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
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.
The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
An optional map of output bindings that controls which bindings the sequence commits to the session state after all steps complete. If omitted, MediaTailor commits all accumulated output bindings from all child steps.
" } }, "FunctionList": { "target": "com.amazonaws.mediatailor#__listOfFunctionsRef", "traits": { "smithy.api#documentation": "An ordered list of 1 to 10 steps. Each step specifies a child function to execute and an optional run condition expression that controls whether the step runs. MediaTailor executes steps in order, passing data between steps through temporary data.
", "smithy.api#required": {} } }, "TimeoutMilliseconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum time, in milliseconds, for the entire sequence to complete. This timeout covers all steps, including any HTTP calls made by child functions. If the sequence exceeds this timeout, MediaTailor discards all output from the sequence and proceeds with default behavior.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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.
The name of the source location where the slate VOD source is stored.
" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
" } } }, "traits": { "smithy.api#documentation": "Slate VOD source configuration.
" } }, "com.amazonaws.mediatailor#SourceLocation": { "type": "structure", "members": { "AccessConfiguration": { "target": "com.amazonaws.mediatailor#AccessConfiguration", "traits": { "smithy.api#documentation": "The access configuration for the source location.
" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN of the SourceLocation.
", "smithy.api#required": {} } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the source location was created.
" } }, "DefaultSegmentDeliveryConfiguration": { "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "The default segment delivery configuration.
" } }, "HttpConfiguration": { "target": "com.amazonaws.mediatailor#HttpConfiguration", "traits": { "smithy.api#documentation": "The HTTP configuration for the source location.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the source location was last modified.
" } }, "SegmentDeliveryConfigurations": { "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "The segment delivery configurations for the source location.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned 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.
", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#documentation": "A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", "smithy.api#references": [ { "resource": "com.amazonaws.mediatailor#SourceLocationResource" } ] } }, "com.amazonaws.mediatailor#SourceLocationResource": { "type": "resource", "identifiers": { "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string" } }, "put": { "target": "com.amazonaws.mediatailor#CreateSourceLocation" }, "read": { "target": "com.amazonaws.mediatailor#DescribeSourceLocation" }, "update": { "target": "com.amazonaws.mediatailor#UpdateSourceLocation" }, "delete": { "target": "com.amazonaws.mediatailor#DeleteSourceLocation" }, "list": { "target": "com.amazonaws.mediatailor#ListSourceLocations" }, "traits": { "aws.api#arn": { "template": "sourceLocation/{SourceLocationName}" }, "aws.api#taggable": {}, "aws.cloudformation#cfnResource": { "name": "SourceLocation" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "sourceLocation", "relativeDocumentation": "sourcelocation-sourcelocationname.html" }, "smithy.api#documentation": "Represents an origin server where source content is stored", "smithy.api#noReplace": {}, "smithy.api#unstable": {} } }, "com.amazonaws.mediatailor#SpliceInsertMessage": { "type": "structure", "members": { "AvailNum": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "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.
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.
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.
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.
Splice insert message configuration.
" } }, "com.amazonaws.mediatailor#StartChannel": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#StartChannelRequest" }, "output": { "target": "com.amazonaws.mediatailor#StartChannelResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to start the channel with the specified channel name", "relativeDocumentation": "channel-channelname-start.html", "resources": { "required": { "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/channel/{ChannelName}/start", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#StartChannelRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#StartChannelResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#StopChannel": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#StopChannelRequest" }, "output": { "target": "com.amazonaws.mediatailor#StopChannelResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to stop the channel with the specified channel name", "relativeDocumentation": "channel-channelname-stop.html", "resources": { "required": { "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/channel/{ChannelName}/stop", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#StopChannelRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#StopChannelResponse": { "type": "structure", "members": {} }, "com.amazonaws.mediatailor#StreamingMediaFileConditioning": { "type": "enum", "members": { "TRANSCODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSCODE" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.mediatailor#StringMap": { "type": "map", "key": { "target": "com.amazonaws.mediatailor#__string" }, "value": { "target": "com.amazonaws.mediatailor#__string" } }, "com.amazonaws.mediatailor#TagFilterList": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#HlsTagName" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.mediatailor#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#TagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.mediatailor#BadRequestException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to add tags to the specified playback configuration resource", "relativeDocumentation": "tags-resourcearn.html", "resources": { "optional": { "playbackConfiguration": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] }, "channel": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] }, "sourceLocation": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] }, "vodSource": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] }, "liveSource": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] }, "function": { "conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", "code": 204 } } }, "com.amazonaws.mediatailor#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags", "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#Tier": { "type": "enum", "members": { "BASIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BASIC" } }, "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } } } }, "com.amazonaws.mediatailor#TimeShiftConfiguration": { "type": "structure", "members": { "MaxTimeDelaySeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The configuration for time-shifted viewing.
" } }, "com.amazonaws.mediatailor#TimeSignalMessage": { "type": "structure", "members": { "SegmentationDescriptors": { "target": "com.amazonaws.mediatailor#SegmentationDescriptorList", "traits": { "smithy.api#documentation": "The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
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.
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.mediatailor#TrafficShapingTpsConfiguration": { "type": "structure", "members": { "PeakTps": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
" } }, "PeakConcurrentUsers": { "target": "com.amazonaws.mediatailor#__integer", "traits": { "smithy.api#documentation": "The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.mediatailor#TrafficShapingType": { "type": "enum", "members": { "RETRIEVAL_WINDOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETRIEVAL_WINDOW" } }, "TPS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TPS" } } } }, "com.amazonaws.mediatailor#Transition": { "type": "structure", "members": { "DurationMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#documentation": "The duration of the live program in seconds.
" } }, "RelativePosition": { "target": "com.amazonaws.mediatailor#RelativePosition", "traits": { "smithy.api#documentation": "The position where this program will be inserted relative to the RelativePosition.
The name of the program that this program will be inserted next to, as defined by RelativePosition.
The date and time that the program is scheduled to start, in epoch milliseconds.
" } }, "Type": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "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.
Program transition configuration.
" } }, "com.amazonaws.mediatailor#Type": { "type": "enum", "members": { "DASH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DASH" } }, "HLS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HLS" } } } }, "com.amazonaws.mediatailor#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.mediatailor#BadRequestException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to remove tags from the specified playback configuration resource", "relativeDocumentation": "tags-resourcearn.html", "resources": { "optional": { "playbackConfiguration": { "conditionKeys": [ "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] }, "channel": { "conditionKeys": [ "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] }, "sourceLocation": { "conditionKeys": [ "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] }, "vodSource": { "conditionKeys": [ "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] }, "liveSource": { "conditionKeys": [ "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] }, "function": { "conditionKeys": [ "aws:TagKeys", "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "The resource to untag.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{ResourceArn}", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to untag.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.mediatailor#__listOf__string", "traits": { "smithy.api#documentation": "The tag keys associated with the resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#UpdateChannel": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#UpdateChannelRequest" }, "output": { "target": "com.amazonaws.mediatailor#UpdateChannelResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update the channel with the specified channel name", "relativeDocumentation": "channel-channelname.html", "resources": { "required": { "channel": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/channel/{ChannelName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#UpdateChannelRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "FillerSlate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { "smithy.api#documentation": "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.
The channel's output properties.
", "smithy.api#required": {} } }, "TimeShiftConfiguration": { "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", "traits": { "smithy.api#documentation": "The time-shifted viewing configuration you want to associate to the channel.
" } }, "Audiences": { "target": "com.amazonaws.mediatailor#Audiences", "traits": { "smithy.api#documentation": "The list of audiences defined in channel.
" } } } }, "com.amazonaws.mediatailor#UpdateChannelResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the channel.
" } }, "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel.
" } }, "ChannelState": { "target": "com.amazonaws.mediatailor#ChannelState", "traits": { "smithy.api#documentation": "Returns the state whether the channel is running or not.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp of when the channel was created.
" } }, "FillerSlate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { "smithy.api#documentation": "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.
The timestamp that indicates when the channel was last modified.
" } }, "Outputs": { "target": "com.amazonaws.mediatailor#ResponseOutputs", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The channel's output properties.
", "smithy.api#unstable": {} } }, "PlaybackMode": { "target": "com.amazonaws.mediatailor#__string", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "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.
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.
", "smithy.api#jsonName": "tags" } }, "Tier": { "target": "com.amazonaws.mediatailor#__string", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The tier associated with this Channel.
", "smithy.api#unstable": {} } }, "TimeShiftConfiguration": { "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", "traits": { "smithy.api#documentation": "The time-shifted viewing configuration for the channel.
" } }, "Audiences": { "target": "com.amazonaws.mediatailor#Audiences", "traits": { "smithy.api#documentation": "The list of audiences defined in channel.
" } } } }, "com.amazonaws.mediatailor#UpdateLiveSource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#UpdateLiveSourceRequest" }, "output": { "target": "com.amazonaws.mediatailor#UpdateLiveSourceResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update the live source with the specified live source name on the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname-livesource-livesourcename.html", "resources": { "required": { "liveSource": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Updates a live source's configuration.
", "smithy.api#http": { "method": "PUT", "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#UpdateLiveSourceRequest": { "type": "structure", "members": { "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "A list of HTTP package configurations for the live source on this account.
", "smithy.api#required": {} } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the live source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location associated with this Live Source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#UpdateLiveSourceResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with this live source.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the live source was created.
" } }, "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "A list of HTTP package configurations for the live source on this account.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the live source was last modified.
" } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the live source.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location associated with the live source.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#UpdateProgram": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#UpdateProgramRequest" }, "output": { "target": "com.amazonaws.mediatailor#UpdateProgramResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update the program with the specified program name on the channel with the specified channel name", "relativeDocumentation": "channel-channelname-program-programname.html", "resources": { "required": { "program": {} } } }, "smithy.api#documentation": "Updates a program within a channel.
", "smithy.api#http": { "method": "PUT", "uri": "/channel/{ChannelName}/program/{ProgramName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#UpdateProgramRequest": { "type": "structure", "members": { "AdBreaks": { "target": "com.amazonaws.mediatailor#__listOfAdBreak", "traits": { "smithy.api#documentation": "The ad break configuration settings.
" } }, "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the channel for this Program.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the Program.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ScheduleConfiguration": { "target": "com.amazonaws.mediatailor#UpdateProgramScheduleConfiguration", "traits": { "smithy.api#documentation": "The schedule configuration settings.
", "smithy.api#required": {} } }, "AudienceMedia": { "target": "com.amazonaws.mediatailor#__listOfAudienceMedia", "traits": { "smithy.api#documentation": "The list of AudienceMedia defined in program.
" } } } }, "com.amazonaws.mediatailor#UpdateProgramResponse": { "type": "structure", "members": { "AdBreaks": { "target": "com.amazonaws.mediatailor#__listOfAdBreak", "traits": { "smithy.api#documentation": "The ad break configuration settings.
" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN to assign to the program.
" } }, "ChannelName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the channel for this program.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The time the program was created.
" } }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to this program.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name to assign to the source location for this program.
" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name that's used to refer to a VOD source.
" } }, "LiveSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the LiveSource for this Program.
" } }, "ClipRange": { "target": "com.amazonaws.mediatailor#ClipRange", "traits": { "smithy.api#documentation": "The clip range configuration settings.
" } }, "DurationMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#documentation": "The duration of the live program in milliseconds.
" } }, "ScheduledStartTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The scheduled start time for this Program.
" } }, "AudienceMedia": { "target": "com.amazonaws.mediatailor#__listOfAudienceMedia", "traits": { "smithy.api#documentation": "The list of AudienceMedia defined in program.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned to the program. 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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#UpdateProgramScheduleConfiguration": { "type": "structure", "members": { "Transition": { "target": "com.amazonaws.mediatailor#UpdateProgramTransition", "traits": { "smithy.api#documentation": "Program transition configuration.
" } }, "ClipRange": { "target": "com.amazonaws.mediatailor#ClipRange", "traits": { "smithy.api#documentation": "Program clip range configuration.
" } } }, "traits": { "smithy.api#documentation": "Schedule configuration parameters.
" } }, "com.amazonaws.mediatailor#UpdateProgramTransition": { "type": "structure", "members": { "ScheduledStartTimeMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#documentation": "The date and time that the program is scheduled to start, in epoch milliseconds.
" } }, "DurationMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#documentation": "The duration of the live program in seconds.
" } } }, "traits": { "smithy.api#documentation": "Program transition configuration.
" } }, "com.amazonaws.mediatailor#UpdateSourceLocation": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#UpdateSourceLocationRequest" }, "output": { "target": "com.amazonaws.mediatailor#UpdateSourceLocationResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname.html", "resources": { "required": { "sourceLocation": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "PUT", "uri": "/sourceLocation/{SourceLocationName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#UpdateSourceLocationRequest": { "type": "structure", "members": { "AccessConfiguration": { "target": "com.amazonaws.mediatailor#AccessConfiguration", "traits": { "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" } }, "DefaultSegmentDeliveryConfiguration": { "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "The optional configuration for the host server that serves segments.
" } }, "HttpConfiguration": { "target": "com.amazonaws.mediatailor#HttpConfiguration", "traits": { "smithy.api#documentation": "The HTTP configuration for the source location.
", "smithy.api#required": {} } }, "SegmentDeliveryConfigurations": { "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "A list of the segment delivery configurations associated with this resource.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#UpdateSourceLocationResponse": { "type": "structure", "members": { "AccessConfiguration": { "target": "com.amazonaws.mediatailor#AccessConfiguration", "traits": { "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" } }, "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the source location.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the source location was created.
" } }, "DefaultSegmentDeliveryConfiguration": { "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "The optional configuration for the host server that serves segments.
" } }, "HttpConfiguration": { "target": "com.amazonaws.mediatailor#HttpConfiguration", "traits": { "smithy.api#documentation": "The HTTP configuration for the source location.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the source location was last modified.
" } }, "SegmentDeliveryConfigurations": { "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", "traits": { "smithy.api#documentation": "The segment delivery configurations for the source location. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } } } }, "com.amazonaws.mediatailor#UpdateVodSource": { "type": "operation", "input": { "target": "com.amazonaws.mediatailor#UpdateVodSourceRequest" }, "output": { "target": "com.amazonaws.mediatailor#UpdateVodSourceResponse" }, "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update the VOD source with the specified VOD source name on the source location with the specified source location name", "relativeDocumentation": "sourcelocation-sourcelocationname-vodsource-vodsourcename.html", "resources": { "required": { "vodSource": { "conditionKeys": [ "aws:ResourceTag/${TagKey}" ] } } } }, "smithy.api#documentation": "Updates a VOD source's configuration.
", "smithy.api#http": { "method": "PUT", "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.mediatailor#UpdateVodSourceRequest": { "type": "structure", "members": { "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "A list of HTTP package configurations for the VOD source on this account.
", "smithy.api#required": {} } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location associated with this VOD Source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the VOD source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.mediatailor#UpdateVodSourceResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the VOD source.
" } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the VOD source was created.
" } }, "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "A list of HTTP package configurations for the VOD source on this account.
" } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the VOD source was last modified.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location associated with the VOD source.
" } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "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.
", "smithy.api#jsonName": "tags" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the VOD source.
" } } } }, "com.amazonaws.mediatailor#VastRequestConfiguration": { "type": "structure", "members": { "Runtime": { "target": "com.amazonaws.mediatailor#RuntimeType", "traits": { "smithy.api#documentation": "The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
A map of output bindings. Each key is a namespaced output path (such as temp.wrappedAds), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in a VAST_REQUEST function can reference the response object, which exposes response.parsedAds \u2014 the ads parsed from the VAST response after schema validation and wrapper resolution \u2014 and response.statusCode. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.
The HTTP method for the request to the VAST endpoint. Valid values: GET and POST. Use POST to send a bid request body, such as an OpenRTB payload.
The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint. The timeout covers the entire response, including any wrapper redirects that MediaTailor follows. If the call exceeds this timeout, MediaTailor proceeds with an empty ad list and continues output expression evaluation. Valid values: 100 to 2000.
An expression that evaluates to the VAST endpoint URL. Use {%...%} delimiters for dynamic expressions. A literal value must be an https:// URL. The expression can be up to 25,000 characters, and the URL after evaluation can be up to 2,048 characters.
An expression that evaluates to the request body, for example to send an OpenRTB bid request. The expression can be up to 100,000 characters, and the body after evaluation can be up to 64 KB.
" } }, "Headers": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound request. Headers beginning with X-Amz- are reserved by the service, and method override headers are not allowed.
The optional response-caching configuration for the function. When present, MediaTailor caches the responses that the function receives from the HTTP endpoint, within the time-to-live (TTL) bounds that you specify. Omit this configuration to disable response caching.
" } } }, "traits": { "smithy.api#documentation": "The configuration for a VAST_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions for a request to a VAST endpoint. MediaTailor parses the response as VAST and resolves wrapper redirects, then makes the parsed ads available to the function's output expressions. For more information, see Function types and composition in the MediaTailor User Guide.
The ad sequencing mode that controls how MediaTailor handles sequenced and standalone ads in VAST responses. FOLLOW_AD_SEQUENCE inserts sequenced ads in increasing order for both live and VOD workflows, using standalone ads only as replacements when a sequenced ad fails. FOLLOW_AD_SEQUENCE_ONLY_LIVE enables ad sequencing for live workflows only. FOLLOW_AD_SEQUENCE_ONLY_VOD enables ad sequencing for VOD workflows only. IGNORE_AD_SEQUENCE inserts ads in the order they appear in the VAST response, regardless of sequence attributes. The default behavior is IGNORE_AD_SEQUENCE.
The settings that control how MediaTailor processes VAST responses from the ad decision server.
" } }, "com.amazonaws.mediatailor#VodSource": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The ARN for the VOD source.
", "smithy.api#required": {} } }, "CreationTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the VOD source was created.
" } }, "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { "smithy.api#documentation": "The HTTP package configurations for the VOD source.
", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { "smithy.api#documentation": "The timestamp that indicates when the VOD source was last modified.
" } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the source location that the VOD source is associated with.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.mediatailor#__mapOf__string", "traits": { "smithy.api#documentation": "The tags assigned 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.
", "smithy.api#jsonName": "tags" } }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { "smithy.api#documentation": "The name of the VOD source.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "VOD source configuration parameters.
", "smithy.api#references": [ { "resource": "com.amazonaws.mediatailor#VodSourceResource" } ] } }, "com.amazonaws.mediatailor#VodSourceResource": { "type": "resource", "identifiers": { "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string" }, "VodSourceName": { "target": "com.amazonaws.mediatailor#__string" } }, "put": { "target": "com.amazonaws.mediatailor#CreateVodSource" }, "read": { "target": "com.amazonaws.mediatailor#DescribeVodSource" }, "update": { "target": "com.amazonaws.mediatailor#UpdateVodSource" }, "delete": { "target": "com.amazonaws.mediatailor#DeleteVodSource" }, "list": { "target": "com.amazonaws.mediatailor#ListVodSources" }, "traits": { "aws.api#arn": { "template": "vodSource/{SourceLocationName}/{VodSourceName}" }, "aws.api#taggable": {}, "aws.cloudformation#cfnResource": { "name": "VodSource" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "vodSource", "relativeDocumentation": "sourcelocation-sourcelocationname-vodsource-vodsourcename.html" }, "smithy.api#documentation": "Represents a single piece of content that can be added to a source location", "smithy.api#noReplace": {}, "smithy.api#unstable": {} } }, "com.amazonaws.mediatailor#YieldOptimizationConfiguration": { "type": "structure", "members": { "MinimumUnfilledDuration": { "target": "com.amazonaws.mediatailor#MinimumUnfilledDurationSeconds", "traits": { "smithy.api#documentation": "The minimum unfilled duration, in seconds, that must remain in an ad break before MediaTailor requests additional ads from Amazon Publisher Services (APS). For example, if set to 6 seconds, yield optimization triggers only when at least 6 seconds of unfilled time remains after the primary ad server response.
", "smithy.api#required": {} } }, "PublisherId": { "target": "com.amazonaws.mediatailor#ApsPublisherId", "traits": { "smithy.api#documentation": "Publisher ID for an existing Amazon Publisher Services configuration. This ID must be obtained by registering with APS prior to using the Yield Optimization feature. The Publisher ID identifies your account in the APS system and is required for all bid requests.
", "smithy.api#required": {} } }, "Region": { "target": "com.amazonaws.mediatailor#ApsRegion", "traits": { "smithy.api#documentation": "The Amazon Publisher Services (APS) region that MediaTailor sends bid requests to. Choose the region closest to your primary audience, because the selection affects both latency and the ad inventory available to you. This setting applies to the entire playback configuration, not to individual viewers. If you serve traffic across multiple regions, create a separate playback configuration for each APS region.
", "smithy.api#required": {} } }, "OpenRtbTemplate": { "target": "com.amazonaws.mediatailor#OpenRtbTemplateString", "traits": { "smithy.api#documentation": "The OpenRTB bid request template, in JSON, that MediaTailor sends to Amazon Publisher Services (APS). The template must include an imp array with one impression specifying bidfloor, an app object specifying bundle and storeurl, and a device object specifying ua and ip. Use double curly braces (for example, {{player_params.user_agent}}) to insert session variables and player parameters.
Configuration for Yield Optimization, which fills unsold ad inventory in ad breaks with programmatic ads from Amazon Publisher Services (APS).
" } }, "com.amazonaws.mediatailor#__adsInteractionExcludeEventTypesList": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#AdsInteractionExcludeEventType" } }, "com.amazonaws.mediatailor#__adsInteractionPublishOptInEventTypesList": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#AdsInteractionPublishOptInEventType" } }, "com.amazonaws.mediatailor#__boolean": { "type": "boolean" }, "com.amazonaws.mediatailor#__integer": { "type": "integer" }, "com.amazonaws.mediatailor#__integerMin1": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.mediatailor#__integerMin1Max100": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.mediatailor#__listOfAdBreak": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#AdBreak" } }, "com.amazonaws.mediatailor#__listOfAlert": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#Alert" } }, "com.amazonaws.mediatailor#__listOfAlternateMedia": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#AlternateMedia" } }, "com.amazonaws.mediatailor#__listOfAudienceMedia": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#AudienceMedia" } }, "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#AvailMatchingCriteria" } }, "com.amazonaws.mediatailor#__listOfChannel": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#Channel" } }, "com.amazonaws.mediatailor#__listOfFunctionsRef": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#FunctionRef" } }, "com.amazonaws.mediatailor#__listOfFunctionsResponse": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#Function" } }, "com.amazonaws.mediatailor#__listOfLiveSource": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#LiveSource" } }, "com.amazonaws.mediatailor#__listOfLoggingStrategies": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#LoggingStrategy" } }, "com.amazonaws.mediatailor#__listOfPlaybackConfiguration": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#PlaybackConfiguration" } }, "com.amazonaws.mediatailor#__listOfPrefetchSchedule": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#PrefetchSchedule" } }, "com.amazonaws.mediatailor#__listOfScheduleAdBreak": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#ScheduleAdBreak" } }, "com.amazonaws.mediatailor#__listOfScheduleEntry": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#ScheduleEntry" } }, "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#SegmentDeliveryConfiguration" } }, "com.amazonaws.mediatailor#__listOfSourceLocation": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#SourceLocation" } }, "com.amazonaws.mediatailor#__listOfVodSource": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#VodSource" } }, "com.amazonaws.mediatailor#__listOf__string": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#__string" } }, "com.amazonaws.mediatailor#__long": { "type": "long" }, "com.amazonaws.mediatailor#__manifestServiceExcludeEventTypesList": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#ManifestServiceExcludeEventType" } }, "com.amazonaws.mediatailor#__manifestServicePublishOptInEventTypesList": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#ManifestServicePublishOptInEventType" } }, "com.amazonaws.mediatailor#__mapOf__string": { "type": "map", "key": { "target": "com.amazonaws.mediatailor#__string" }, "value": { "target": "com.amazonaws.mediatailor#__string" } }, "com.amazonaws.mediatailor#__string": { "type": "string" }, "com.amazonaws.mediatailor#__timestampUnix": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "epoch-seconds" } }, "com.amazonaws.mediatailor#adMarkupTypes": { "type": "list", "member": { "target": "com.amazonaws.mediatailor#AdMarkupType" } } } }