aws-elixir

View Source AWS.MediaTailor (aws-elixir v1.0.4)

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

Link to this section Summary

Functions

configure_logs_for_channel(client, input, options \\ [])

Configures Amazon CloudWatch log settings for a channel.

configure_logs_for_playback_configuration(client, input, options \\ [])

Amazon CloudWatch log settings for a playback configuration.

create_channel(client, channel_name, input, options \\ [])

Creates a channel.

create_live_source(client, live_source_name, source_location_name, input, options \\ [])

The live source configuration.

create_prefetch_schedule(client, name, playback_configuration_name, input, options \\ [])

Creates a prefetch schedule for a playback configuration.

create_program(client, channel_name, program_name, input, options \\ [])

Creates a program within a channel.

create_source_location(client, source_location_name, input, options \\ [])

Creates a source location.

create_vod_source(client, source_location_name, vod_source_name, input, options \\ [])

The VOD source configuration parameters.

delete_channel(client, channel_name, input, options \\ [])

Deletes a channel.

delete_channel_policy(client, channel_name, input, options \\ [])

The channel policy to delete.

delete_live_source(client, live_source_name, source_location_name, input, options \\ [])

The live source to delete.

delete_playback_configuration(client, name, input, options \\ [])

Deletes a playback configuration.

delete_prefetch_schedule(client, name, playback_configuration_name, input, options \\ [])

Deletes a prefetch schedule for a specific playback configuration.

delete_program(client, channel_name, program_name, input, options \\ [])

Deletes a program within a channel.

delete_source_location(client, source_location_name, input, options \\ [])

Deletes a source location.

delete_vod_source(client, source_location_name, vod_source_name, input, options \\ [])

The video on demand (VOD) source to delete.

describe_channel(client, channel_name, options \\ [])

Describes a channel.

describe_live_source(client, live_source_name, source_location_name, options \\ [])

The live source to describe.

describe_program(client, channel_name, program_name, options \\ [])

Describes a program within a channel.

describe_source_location(client, source_location_name, options \\ [])

Describes a source location.

describe_vod_source(client, source_location_name, vod_source_name, options \\ [])

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

get_channel_policy(client, channel_name, options \\ [])

Returns the channel's IAM policy.

get_channel_schedule(client, channel_name, audience \\ nil, duration_minutes \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Retrieves information about your channel's schedule.

get_playback_configuration(client, name, options \\ [])

Retrieves a playback configuration.

get_prefetch_schedule(client, name, playback_configuration_name, options \\ [])

Retrieves a prefetch schedule for a playback configuration.

list_alerts(client, max_results \\ nil, next_token \\ nil, resource_arn, options \\ [])

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

list_channels(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_live_sources(client, source_location_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the live sources contained in a source location.

list_playback_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Retrieves existing playback configurations.

list_prefetch_schedules(client, playback_configuration_name, input, options \\ [])

Lists the prefetch schedules for a playback configuration.

list_source_locations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the source locations for a channel.

list_tags_for_resource(client, resource_arn, options \\ [])

A list of tags that are associated with this resource.

list_vod_sources(client, source_location_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the VOD sources contained in a source location.

metadata()
put_channel_policy(client, channel_name, input, options \\ [])

Creates an IAM policy for the channel.

put_playback_configuration(client, input, options \\ [])

Creates a playback configuration.

start_channel(client, channel_name, input, options \\ [])

Starts a channel.

stop_channel(client, channel_name, input, options \\ [])

Stops a channel.

tag_resource(client, resource_arn, input, options \\ [])

The resource to tag.

untag_resource(client, resource_arn, input, options \\ [])

The resource to untag.

update_channel(client, channel_name, input, options \\ [])

Updates a channel.

update_live_source(client, live_source_name, source_location_name, input, options \\ [])

Updates a live source's configuration.

update_program(client, channel_name, program_name, input, options \\ [])

Updates a program within a channel.

update_source_location(client, source_location_name, input, options \\ [])

Updates a source location.

update_vod_source(client, source_location_name, vod_source_name, input, options \\ [])

Updates a VOD source's configuration.

Link to this section Functions

Link to this function

configure_logs_for_channel(client, input, options \\ [])

View Source

Configures Amazon CloudWatch log settings for a channel.

Link to this function

configure_logs_for_playback_configuration(client, input, options \\ [])

View Source

Amazon CloudWatch log settings for a playback configuration.

Link to this function

create_channel(client, channel_name, input, options \\ [])

View Source

Creates a channel.

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

Link to this function

create_live_source(client, live_source_name, source_location_name, input, options \\ [])

View Source

The live source configuration.

Link to this function

create_prefetch_schedule(client, name, playback_configuration_name, input, options \\ [])

View Source

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.

Link to this function

create_program(client, channel_name, program_name, input, options \\ [])

View Source

Creates a program within a channel.

For information about programs, see Working with programs in the MediaTailor User Guide.

Link to this function

create_source_location(client, source_location_name, input, options \\ [])

View Source

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.

Link to this function

create_vod_source(client, source_location_name, vod_source_name, input, options \\ [])

View Source

The VOD source configuration parameters.

Link to this function

delete_channel(client, channel_name, input, options \\ [])

View Source

Deletes a channel.

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

Link to this function

delete_channel_policy(client, channel_name, input, options \\ [])

View Source

The channel policy to delete.

Link to this function

delete_live_source(client, live_source_name, source_location_name, input, options \\ [])

View Source

The live source to delete.

Link to this function

delete_playback_configuration(client, name, input, options \\ [])

View Source

Deletes a playback configuration.

For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

Link to this function

delete_prefetch_schedule(client, name, playback_configuration_name, input, options \\ [])

View Source

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.

Link to this function

delete_program(client, channel_name, program_name, input, options \\ [])

View Source

Deletes a program within a channel.

For information about programs, see Working with programs in the MediaTailor User Guide.

Link to this function

delete_source_location(client, source_location_name, input, options \\ [])

View Source

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.

Link to this function

delete_vod_source(client, source_location_name, vod_source_name, input, options \\ [])

View Source

The video on demand (VOD) source to delete.

Link to this function

describe_channel(client, channel_name, options \\ [])

View Source

Describes a channel.

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

Link to this function

describe_live_source(client, live_source_name, source_location_name, options \\ [])

View Source

The live source to describe.

Link to this function

describe_program(client, channel_name, program_name, options \\ [])

View Source

Describes a program within a channel.

For information about programs, see Working with programs in the MediaTailor User Guide.

Link to this function

describe_source_location(client, source_location_name, options \\ [])

View Source

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.

Link to this function

describe_vod_source(client, source_location_name, vod_source_name, options \\ [])

View Source

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

Link to this function

get_channel_policy(client, channel_name, options \\ [])

View Source

Returns the channel's IAM policy.

IAM policies are used to control access to your channel.

Link to this function

get_channel_schedule(client, channel_name, audience \\ nil, duration_minutes \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves information about your channel's schedule.

Link to this function

get_playback_configuration(client, name, options \\ [])

View Source

Retrieves a playback configuration.

For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

Link to this function

get_prefetch_schedule(client, name, playback_configuration_name, options \\ [])

View Source

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.

Link to this function

list_alerts(client, max_results \\ nil, next_token \\ nil, resource_arn, options \\ [])

View Source

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

Link to this function

list_channels(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_live_sources(client, source_location_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the live sources contained in a source location.

A source represents a piece of content.

Link to this function

list_playback_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves existing playback configurations.

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

Link to this function

list_prefetch_schedules(client, playback_configuration_name, input, options \\ [])

View Source

Lists the prefetch schedules for a playback configuration.

Link to this function

list_source_locations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the source locations for a channel.

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

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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.

Link to this function

list_vod_sources(client, source_location_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the VOD sources contained in a source location.

A source represents a piece of content.

Link to this function

metadata()

View Source
Link to this function

put_channel_policy(client, channel_name, input, options \\ [])

View Source

Creates an IAM policy for the channel.

IAM policies are used to control access to your channel.

Link to this function

put_playback_configuration(client, input, options \\ [])

View Source

Creates a playback configuration.

For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

Link to this function

start_channel(client, channel_name, input, options \\ [])

View Source

Starts a channel.

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

Link to this function

stop_channel(client, channel_name, input, options \\ [])

View Source

Stops a channel.

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

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

The resource to untag.

Link to this function

update_channel(client, channel_name, input, options \\ [])

View Source

Updates a channel.

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

Link to this function

update_live_source(client, live_source_name, source_location_name, input, options \\ [])

View Source

Updates a live source's configuration.

Link to this function

update_program(client, channel_name, program_name, input, options \\ [])

View Source

Updates a program within a channel.

Link to this function

update_source_location(client, source_location_name, input, options \\ [])

View Source

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.

Link to this function

update_vod_source(client, source_location_name, vod_source_name, input, options \\ [])

View Source

Updates a VOD source's configuration.