mediatailor/aws.sdk.kotlin.services.mediatailor

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

configureLogsForChannel

inline suspend fun MediaTailorClient.configureLogsForChannel(crossinline block: ConfigureLogsForChannelRequest.Builder.() -> Unit): ConfigureLogsForChannelResponse

Configures Amazon CloudWatch log settings for a channel.

configureLogsForPlaybackConfiguration

inline suspend fun MediaTailorClient.configureLogsForPlaybackConfiguration(crossinline block: ConfigureLogsForPlaybackConfigurationRequest.Builder.() -> Unit): ConfigureLogsForPlaybackConfigurationResponse

Amazon CloudWatch log settings for a playback configuration.

createChannel

inline suspend fun MediaTailorClient.createChannel(crossinline block: CreateChannelRequest.Builder.() -> Unit): CreateChannelResponse

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

createLiveSource

inline suspend fun MediaTailorClient.createLiveSource(crossinline block: CreateLiveSourceRequest.Builder.() -> Unit): CreateLiveSourceResponse

The live source configuration.

createPrefetchSchedule

inline suspend fun MediaTailorClient.createPrefetchSchedule(crossinline block: CreatePrefetchScheduleRequest.Builder.() -> Unit): CreatePrefetchScheduleResponse

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.

createProgram

inline suspend fun MediaTailorClient.createProgram(crossinline block: CreateProgramRequest.Builder.() -> Unit): CreateProgramResponse

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

createSourceLocation

inline suspend fun MediaTailorClient.createSourceLocation(crossinline block: CreateSourceLocationRequest.Builder.() -> Unit): CreateSourceLocationResponse

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.

createVodSource

inline suspend fun MediaTailorClient.createVodSource(crossinline block: CreateVodSourceRequest.Builder.() -> Unit): CreateVodSourceResponse

The VOD source configuration parameters.

deleteChannel

inline suspend fun MediaTailorClient.deleteChannel(crossinline block: DeleteChannelRequest.Builder.() -> Unit): DeleteChannelResponse

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

deleteChannelPolicy

inline suspend fun MediaTailorClient.deleteChannelPolicy(crossinline block: DeleteChannelPolicyRequest.Builder.() -> Unit): DeleteChannelPolicyResponse

The channel policy to delete.

deleteLiveSource

inline suspend fun MediaTailorClient.deleteLiveSource(crossinline block: DeleteLiveSourceRequest.Builder.() -> Unit): DeleteLiveSourceResponse

The live source to delete.

deletePlaybackConfiguration

inline suspend fun MediaTailorClient.deletePlaybackConfiguration(crossinline block: DeletePlaybackConfigurationRequest.Builder.() -> Unit): DeletePlaybackConfigurationResponse

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

deletePrefetchSchedule

inline suspend fun MediaTailorClient.deletePrefetchSchedule(crossinline block: DeletePrefetchScheduleRequest.Builder.() -> Unit): DeletePrefetchScheduleResponse

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.

deleteProgram

inline suspend fun MediaTailorClient.deleteProgram(crossinline block: DeleteProgramRequest.Builder.() -> Unit): DeleteProgramResponse

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

deleteSourceLocation

inline suspend fun MediaTailorClient.deleteSourceLocation(crossinline block: DeleteSourceLocationRequest.Builder.() -> Unit): DeleteSourceLocationResponse

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.

deleteVodSource

inline suspend fun MediaTailorClient.deleteVodSource(crossinline block: DeleteVodSourceRequest.Builder.() -> Unit): DeleteVodSourceResponse

The video on demand (VOD) source to delete.

describeChannel

inline suspend fun MediaTailorClient.describeChannel(crossinline block: DescribeChannelRequest.Builder.() -> Unit): DescribeChannelResponse

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

describeLiveSource

inline suspend fun MediaTailorClient.describeLiveSource(crossinline block: DescribeLiveSourceRequest.Builder.() -> Unit): DescribeLiveSourceResponse

The live source to describe.

describeProgram

inline suspend fun MediaTailorClient.describeProgram(crossinline block: DescribeProgramRequest.Builder.() -> Unit): DescribeProgramResponse

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

describeSourceLocation

inline suspend fun MediaTailorClient.describeSourceLocation(crossinline block: DescribeSourceLocationRequest.Builder.() -> Unit): DescribeSourceLocationResponse

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.

describeVodSource

inline suspend fun MediaTailorClient.describeVodSource(crossinline block: DescribeVodSourceRequest.Builder.() -> Unit): DescribeVodSourceResponse

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

getChannelPolicy

inline suspend fun MediaTailorClient.getChannelPolicy(crossinline block: GetChannelPolicyRequest.Builder.() -> Unit): GetChannelPolicyResponse

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

getChannelSchedule

inline suspend fun MediaTailorClient.getChannelSchedule(crossinline block: GetChannelScheduleRequest.Builder.() -> Unit): GetChannelScheduleResponse

Retrieves information about your channel's schedule.

getPlaybackConfiguration

inline suspend fun MediaTailorClient.getPlaybackConfiguration(crossinline block: GetPlaybackConfigurationRequest.Builder.() -> Unit): GetPlaybackConfigurationResponse

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

getPrefetchSchedule

inline suspend fun MediaTailorClient.getPrefetchSchedule(crossinline block: GetPrefetchScheduleRequest.Builder.() -> Unit): GetPrefetchScheduleResponse

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.

listAlerts

inline suspend fun MediaTailorClient.listAlerts(crossinline block: ListAlertsRequest.Builder.() -> Unit): ListAlertsResponse

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

listChannels

inline suspend fun MediaTailorClient.listChannels(crossinline block: ListChannelsRequest.Builder.() -> Unit): ListChannelsResponse

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

listLiveSources

inline suspend fun MediaTailorClient.listLiveSources(crossinline block: ListLiveSourcesRequest.Builder.() -> Unit): ListLiveSourcesResponse

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

listPlaybackConfigurations

inline suspend fun MediaTailorClient.listPlaybackConfigurations(crossinline block: ListPlaybackConfigurationsRequest.Builder.() -> Unit): ListPlaybackConfigurationsResponse

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

listPrefetchSchedules

inline suspend fun MediaTailorClient.listPrefetchSchedules(crossinline block: ListPrefetchSchedulesRequest.Builder.() -> Unit): ListPrefetchSchedulesResponse

Lists the prefetch schedules for a playback configuration.

listSourceLocations

inline suspend fun MediaTailorClient.listSourceLocations(crossinline block: ListSourceLocationsRequest.Builder.() -> Unit): ListSourceLocationsResponse

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

listTagsForResource

inline suspend fun MediaTailorClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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.

listVodSources

inline suspend fun MediaTailorClient.listVodSources(crossinline block: ListVodSourcesRequest.Builder.() -> Unit): ListVodSourcesResponse

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

putChannelPolicy

inline suspend fun MediaTailorClient.putChannelPolicy(crossinline block: PutChannelPolicyRequest.Builder.() -> Unit): PutChannelPolicyResponse

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

putPlaybackConfiguration

inline suspend fun MediaTailorClient.putPlaybackConfiguration(crossinline block: PutPlaybackConfigurationRequest.Builder.() -> Unit): PutPlaybackConfigurationResponse

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

startChannel

inline suspend fun MediaTailorClient.startChannel(crossinline block: StartChannelRequest.Builder.() -> Unit): StartChannelResponse

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

stopChannel

inline suspend fun MediaTailorClient.stopChannel(crossinline block: StopChannelRequest.Builder.() -> Unit): StopChannelResponse

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

tagResource

inline suspend fun MediaTailorClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

untagResource

inline suspend fun MediaTailorClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

The resource to untag.

updateChannel

inline suspend fun MediaTailorClient.updateChannel(crossinline block: UpdateChannelRequest.Builder.() -> Unit): UpdateChannelResponse

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

updateLiveSource

inline suspend fun MediaTailorClient.updateLiveSource(crossinline block: UpdateLiveSourceRequest.Builder.() -> Unit): UpdateLiveSourceResponse

Updates a live source's configuration.

updateProgram

inline suspend fun MediaTailorClient.updateProgram(crossinline block: UpdateProgramRequest.Builder.() -> Unit): UpdateProgramResponse

Updates a program within a channel.

updateSourceLocation

inline suspend fun MediaTailorClient.updateSourceLocation(crossinline block: UpdateSourceLocationRequest.Builder.() -> Unit): UpdateSourceLocationResponse

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.

updateVodSource

inline suspend fun MediaTailorClient.updateVodSource(crossinline block: UpdateVodSourceRequest.Builder.() -> Unit): UpdateVodSourceResponse

Updates a VOD source's configuration.

withConfig

fun MediaTailorClient.withConfig(block: MediaTailorClient.Config.Builder.() -> Unit): MediaTailorClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.