MediaTailorClient

Suggest an Edit

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

Installation

NPM
npm install @aws-sdk/client-mediatailor
Yarn
yarn add @aws-sdk/client-mediatailor
pnpm
pnpm add @aws-sdk/client-mediatailor

MediaTailorClient Operations

Command
Summary
ConfigureLogsForChannelCommand

Configures Amazon CloudWatch log settings for a channel.

ConfigureLogsForPlaybackConfigurationCommand

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

CreateChannelCommand

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

CreateLiveSourceCommand

The live source configuration.

CreatePrefetchScheduleCommand

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.

CreateProgramCommand

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

CreateSourceLocationCommand

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.

CreateVodSourceCommand

The VOD source configuration parameters.

DeleteChannelCommand

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

DeleteChannelPolicyCommand

The channel policy to delete.

DeleteLiveSourceCommand

The live source to delete.

DeletePlaybackConfigurationCommand

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

DeletePrefetchScheduleCommand

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.

DeleteProgramCommand

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

DeleteSourceLocationCommand

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.

DeleteVodSourceCommand

The video on demand (VOD) source to delete.

DescribeChannelCommand

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

DescribeLiveSourceCommand

The live source to describe.

DescribeProgramCommand

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

DescribeSourceLocationCommand

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.

DescribeVodSourceCommand

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

GetChannelPolicyCommand

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

GetChannelScheduleCommand

Retrieves information about your channel's schedule.

GetPlaybackConfigurationCommand

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

GetPrefetchScheduleCommand

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.

ListAlertsCommand

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

ListChannelsCommand

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

ListLiveSourcesCommand

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

ListPlaybackConfigurationsCommand

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

ListPrefetchSchedulesCommand

Lists the prefetch schedules for a playback configuration.

ListSourceLocationsCommand

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

ListTagsForResourceCommand

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 .

ListVodSourcesCommand

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

PutChannelPolicyCommand

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

PutPlaybackConfigurationCommand

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

StartChannelCommand

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

StopChannelCommand

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

TagResourceCommand

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 .

UntagResourceCommand

The resource to untag.

UpdateChannelCommand

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

UpdateLiveSourceCommand

Updates a live source's configuration.

UpdateProgramCommand

Updates a program within a channel.

UpdateSourceLocationCommand

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.

UpdateVodSourceCommand

Updates a VOD source's configuration.

MediaTailorClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: MediaTailorClientConfig