AWS.MediaTailor (aws-elixir v0.8.0) View Source

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

Creates a source location on a specific channel.

Creates name for a specific VOD source in a source location.

Deletes the playback configuration for the specified name.

Deletes a specific program on a specific channel.

Deletes a source location on a specific channel.

Deletes a specific VOD source in a specific source location.

Describes the properties of a specific channel.

Retrieves the properties of the requested program.

Retrieves the properties of the requested source location.

Provides details about a specific VOD source in a specific source location.

Retrieves information about a channel's IAM policy.

Returns the playback configuration for the specified name.

Retrieves a list of channels that are associated with this account.

Returns a list of the playback configurations defined in AWS Elemental MediaTailor.

Returns a list of the tags assigned to the specified playback configuration resource.

Adds a new playback configuration to AWS Elemental MediaTailor.

Adds tags to the specified playback configuration resource.

Removes tags from the specified playback configuration resource.

Updates a source location on a specific channel.

Updates a specific VOD source in a specific source location.

Link to this section Functions

Link to this function

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

View Source

Creates a channel.

Link to this function

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

View Source

Creates a program.

Link to this function

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

View Source

Creates a source location on a specific channel.

Link to this function

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

View Source

Creates name for a specific VOD source in a source location.

Link to this function

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

View Source

Deletes a channel.

You must stop the channel before it can be deleted.

Link to this function

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

View Source

Deletes a channel's IAM policy.

Link to this function

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

View Source

Deletes the playback configuration for the specified name.

Link to this function

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

View Source

Deletes a specific program on a specific channel.

Link to this function

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

View Source

Deletes a source location on a specific channel.

Link to this function

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

View Source

Deletes a specific VOD source in a specific source location.

Link to this function

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

View Source

Describes the properties of a specific channel.

Link to this function

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

View Source

Retrieves the properties of the requested program.

Link to this function

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

View Source

Retrieves the properties of the requested source location.

Link to this function

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

View Source

Provides details about a specific VOD source in a specific source location.

Link to this function

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

View Source

Retrieves information about a channel's IAM policy.

Link to this function

get_channel_schedule(client, channel_name, 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

Returns the playback configuration for the specified name.

Link to this function

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

View Source

Returns a list of alerts for the given resource.

Link to this function

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

View Source

Retrieves a list of channels that are associated with this account.

Link to this function

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

View Source

Returns a list of the playback configurations defined in AWS Elemental MediaTailor.

You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.

Link to this function

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

View Source

Retrieves a list of source locations.

Link to this function

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

View Source

Returns a list of the tags assigned to the specified playback configuration resource.

Link to this function

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

View Source

Lists all the VOD sources in a source location.

Link to this function

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

View Source

Creates an IAM policy for the channel.

Link to this function

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

View Source

Adds a new playback configuration to AWS Elemental MediaTailor.

Link to this function

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

View Source

Starts a specific channel.

Link to this function

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

View Source

Stops a specific channel.

Link to this function

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

View Source

Adds tags to the specified playback configuration resource.

You can specify one or more tags to add.

Link to this function

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

View Source

Removes tags from the specified playback configuration resource.

You can specify one or more tags to remove.

Link to this function

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

View Source

Updates an existing channel.

Link to this function

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

View Source

Updates a source location on a specific channel.

Link to this function

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

View Source

Updates a specific VOD source in a specific source location.