Aws/mediatailor
@swamp/aws/mediatailorv2026.10.24.1
01README
AWS MEDIATAILOR infrastructure models
02Behaviors
@swamp/aws/mediatailor/channelv2026.10.23.1channel.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Audiences? | array | The list of audiences defined in channel. |
| ChannelName | string | |
| FillerSlate? | object | Slate VOD source configuration. |
| LogConfiguration? | object | The log configuration for the channel. |
| Outputs | array | The channel's output properties. |
| PlaybackMode | enum | |
| Tags? | array | The tags to assign to the channel. |
| Tier? | enum | |
| TimeShiftConfiguration? | object | The configuration for time-shifted viewing. |
fn create()
Create a MediaTailor Channel
fn get(identifier: string)
Get a MediaTailor Channel
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor Channel |
fn update()
Update a MediaTailor Channel
fn delete(identifier: string)
Delete a MediaTailor Channel
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor Channel |
fn sync()
Sync MediaTailor Channel state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MediaTailor Channel resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— MediaTailor Channel resource state
@swamp/aws/mediatailor/channel-policyv2026.10.23.1channel_policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ChannelName | string | |
| Policy | record | The IAM policy for the channel. IAM policies are used to control access to your channel. |
fn create()
Create a MediaTailor ChannelPolicy
fn get(identifier: string)
Get a MediaTailor ChannelPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor ChannelPolicy |
fn update()
Update a MediaTailor ChannelPolicy
fn delete(identifier: string)
Delete a MediaTailor ChannelPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor ChannelPolicy |
fn sync()
Sync MediaTailor ChannelPolicy state from AWS
Resources
state(infinite)— MediaTailor ChannelPolicy resource state
@swamp/aws/mediatailor/functionv2026.10.23.1function.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| FunctionId | string | The unique identifier for the function. |
| FunctionType | enum | The type of the function. Determines which configuration object is used. |
| Description? | string | A description of the function. |
| HttpRequestConfiguration? | object | Configuration for HTTP request functions. |
| AwsServiceRequestConfiguration? | object | 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 (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-types-aws-service-request.html) in the MediaTailor User Guide. |
| CustomOutputConfiguration? | object | Configuration for custom output functions. |
| ConcurrentExecutorConfiguration? | object | The configuration for a CONCURRENT_EXECUTOR function. Required when FunctionType is CONCURRENT_EXECUTOR. |
| SequentialExecutorConfiguration? | object | The configuration for a SEQUENTIAL_EXECUTOR function. A SEQUENTIAL_EXECUTOR runs an ordered list of child functions one at a time, passing data between them. For more information about functions, see Working with functions (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions.html) in the MediaTailor User Guide. |
| VastRequestConfiguration? | object | 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 (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-types.html) in the MediaTailor User Guide. |
| Tags? | array | The tags to assign to the function resource. |
fn create()
Create a MediaTailor Function
fn get(identifier: string)
Get a MediaTailor Function
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor Function |
fn update()
Update a MediaTailor Function
fn delete(identifier: string)
Delete a MediaTailor Function
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor Function |
fn sync()
Sync MediaTailor Function state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MediaTailor Function resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— MediaTailor Function resource state
@swamp/aws/mediatailor/live-sourcev2026.10.23.1live_source.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| HttpPackageConfigurations | array | A list of HTTP package configuration parameters for this live source. |
| LiveSourceName | string | |
| SourceLocationName | string | |
| Tags? | array | The tags to assign to the live source. |
fn create()
Create a MediaTailor LiveSource
fn get(identifier: string)
Get a MediaTailor LiveSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor LiveSource |
fn update()
Update a MediaTailor LiveSource
fn delete(identifier: string)
Delete a MediaTailor LiveSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor LiveSource |
fn sync()
Sync MediaTailor LiveSource state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MediaTailor LiveSource resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— MediaTailor LiveSource resource state
@swamp/aws/mediatailor/playback-configurationv2026.10.23.1playback_configuration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AdConditioningConfiguration? | object | The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns. |
| AdDecisionServerUrl | string | 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? | object | The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html). |
| BeaconingConfiguration? | object | The beaconing configuration for this playback configuration, which controls whether AWS Elemental MediaTailor includes beacons of its own in the ad tracking response. If you omit this setting, MediaTailor uses INSIGHTS. |
| Bumper? | object | The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). |
| CdnConfiguration? | object | The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. |
| DashConfiguration? | object | The configuration for DASH content. |
| InsertionMode? | enum | 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. |
| LivePreRollConfiguration? | object | The configuration for pre-roll ad insertion. |
| ManifestProcessingRules? | object | The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor. |
| Name | string | The identifier for the playback configuration. |
| PersonalizationThresholdSeconds? | number | 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 |
| LogConfiguration? | object | The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration. |
| SlateAdUrl? | string | 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? | array | The tags to assign to the playback configuration. |
| TranscodeProfileName? | string | The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support. |
| VideoContentSourceUrl | string | The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters. |
| AdDecisionServerConfiguration? | object | The configuration for the request to the specified Ad Decision Server URL. |
| FunctionMapping? | record | A map of event names to function identifiers for custom processing during session lifecycle events. |
| AdsPersonalizationTimeouts? | object | The ad decision server (ADS) request timeouts and personalization time budgets for live, VOD, and prefetch workflows. |
| AdsPersonalizationConcurrency? | object | The settings that control how many concurrent requests MediaTailor makes to the ad decision server (ADS). |
fn create()
Create a MediaTailor PlaybackConfiguration
fn get(identifier: string)
Get a MediaTailor PlaybackConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor PlaybackConfiguration |
fn update()
Update a MediaTailor PlaybackConfiguration
fn delete(identifier: string)
Delete a MediaTailor PlaybackConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor PlaybackConfiguration |
fn sync()
Sync MediaTailor PlaybackConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MediaTailor PlaybackConfiguration resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— MediaTailor PlaybackConfiguration resource state
@swamp/aws/mediatailor/prefetch-schedulev2026.10.23.1prefetch_schedule.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name to assign to the prefetch schedule. |
| PlaybackConfigurationName | string | The name of the playback configuration. |
| Consumption? | object | |
| Retrieval? | object | |
| RecurringPrefetchConfiguration? | object | |
| ScheduleType? | enum | The frequency that MediaTailor creates prefetch schedules. |
| StreamId? | string | An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. |
| Tags? | array | The tags assigned to the prefetch schedule. |
fn create()
Create a MediaTailor PrefetchSchedule
fn get(identifier: string)
Get a MediaTailor PrefetchSchedule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor PrefetchSchedule |
fn update()
Update a MediaTailor PrefetchSchedule
fn delete(identifier: string)
Delete a MediaTailor PrefetchSchedule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor PrefetchSchedule |
fn sync()
Sync MediaTailor PrefetchSchedule state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MediaTailor PrefetchSchedule resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— MediaTailor PrefetchSchedule resource state
@swamp/aws/mediatailor/programv2026.10.23.1program.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ChannelName | string | The name of the channel for this Program. |
| ProgramName | string | The name of the Program. |
| SourceLocationName | string | The name of the source location. |
| LiveSourceName? | string | The name of the LiveSource for this Program. |
| VodSourceName? | string | The name that's used to refer to a VOD source. |
| AdBreaks? | array | The ad break configuration settings. |
| AudienceMedia? | array | The list of AudienceMedia defined in program. |
| ScheduleConfiguration? | object | The schedule configuration settings. |
| ClipRange? | object | The clip range configuration settings. |
fn create()
Create a MediaTailor Program
fn get(identifier: string)
Get a MediaTailor Program
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor Program |
fn update()
Update a MediaTailor Program
fn delete(identifier: string)
Delete a MediaTailor Program
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor Program |
fn sync()
Sync MediaTailor Program state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MediaTailor Program resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— MediaTailor Program resource state
@swamp/aws/mediatailor/source-locationv2026.10.23.1source_location.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AccessConfiguration? | object | Access configuration parameters. |
| DefaultSegmentDeliveryConfiguration? | object | 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. |
| HttpConfiguration | object | The HTTP configuration for the source location. |
| SegmentDeliveryConfigurations? | array | A list of the segment delivery configurations associated with this resource. |
| SourceLocationName | string | |
| Tags? | array | The tags to assign to the source location. |
fn create()
Create a MediaTailor SourceLocation
fn get(identifier: string)
Get a MediaTailor SourceLocation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor SourceLocation |
fn update()
Update a MediaTailor SourceLocation
fn delete(identifier: string)
Delete a MediaTailor SourceLocation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor SourceLocation |
fn sync()
Sync MediaTailor SourceLocation state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MediaTailor SourceLocation resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— MediaTailor SourceLocation resource state
@swamp/aws/mediatailor/vod-sourcev2026.10.23.1vod_source.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| HttpPackageConfigurations | array | A list of HTTP package configuration parameters for this VOD source. |
| SourceLocationName | string | |
| Tags? | array | The tags to assign to the VOD source. |
| VodSourceName | string |
fn create()
Create a MediaTailor VodSource
fn get(identifier: string)
Get a MediaTailor VodSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor VodSource |
fn update()
Update a MediaTailor VodSource
fn delete(identifier: string)
Delete a MediaTailor VodSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the MediaTailor VodSource |
fn sync()
Sync MediaTailor VodSource state from AWS
fn list(maxPages?: number, resourceModel?: string)
List MediaTailor VodSource resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— MediaTailor VodSource resource state
03Previous Versions
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: channel, channel_policy, function, live_source, playback_configuration, prefetch_schedule, program, source_location, vod_source
2026.10.13.1
- Updated: channel, channel_policy, function, live_source, playback_configuration, prefetch_schedule, program, source_location, vod_source
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
- Added: program
Added 1 behaviors
2026.09.30.1
2026.09.29.1
- Updated: function, playback_configuration
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
- Updated: function
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
2026.09.20.1
04Stats
A
100 / 100
Downloads
103
Archive size
1.8 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
05Platforms
06Labels