com.amazonaws.services.mediatailor

Interface AWSMediaTailor

All Known Subinterfaces:

AWSMediaTailorAsync

All Known Implementing Classes:

AbstractAWSMediaTailor, AbstractAWSMediaTailorAsync, AWSMediaTailorAsyncClient, AWSMediaTailorClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMediaTailor

Interface for accessing MediaTailor.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMediaTailor instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ConfigureLogsForChannelResult	configureLogsForChannel(ConfigureLogsForChannelRequest configureLogsForChannelRequest) Configures Amazon CloudWatch log settings for a channel.
ConfigureLogsForPlaybackConfigurationResult	configureLogsForPlaybackConfiguration(ConfigureLogsForPlaybackConfigurationRequest configureLogsForPlaybackConfigurationRequest) Amazon CloudWatch log settings for a playback configuration.
CreateChannelResult	createChannel(CreateChannelRequest createChannelRequest) Creates a channel.
CreateLiveSourceResult	createLiveSource(CreateLiveSourceRequest createLiveSourceRequest) The live source configuration.
CreatePrefetchScheduleResult	createPrefetchSchedule(CreatePrefetchScheduleRequest createPrefetchScheduleRequest) Creates a prefetch schedule for a playback configuration.
CreateProgramResult	createProgram(CreateProgramRequest createProgramRequest) Creates a program within a channel.
CreateSourceLocationResult	createSourceLocation(CreateSourceLocationRequest createSourceLocationRequest) Creates a source location.
CreateVodSourceResult	createVodSource(CreateVodSourceRequest createVodSourceRequest) The VOD source configuration parameters.
DeleteChannelResult	deleteChannel(DeleteChannelRequest deleteChannelRequest) Deletes a channel.
DeleteChannelPolicyResult	deleteChannelPolicy(DeleteChannelPolicyRequest deleteChannelPolicyRequest) The channel policy to delete.
DeleteLiveSourceResult	deleteLiveSource(DeleteLiveSourceRequest deleteLiveSourceRequest) The live source to delete.
DeletePlaybackConfigurationResult	deletePlaybackConfiguration(DeletePlaybackConfigurationRequest deletePlaybackConfigurationRequest) Deletes a playback configuration.
DeletePrefetchScheduleResult	deletePrefetchSchedule(DeletePrefetchScheduleRequest deletePrefetchScheduleRequest) Deletes a prefetch schedule for a specific playback configuration.
DeleteProgramResult	deleteProgram(DeleteProgramRequest deleteProgramRequest) Deletes a program within a channel.
DeleteSourceLocationResult	deleteSourceLocation(DeleteSourceLocationRequest deleteSourceLocationRequest) Deletes a source location.
DeleteVodSourceResult	deleteVodSource(DeleteVodSourceRequest deleteVodSourceRequest) The video on demand (VOD) source to delete.
DescribeChannelResult	describeChannel(DescribeChannelRequest describeChannelRequest) Describes a channel.
DescribeLiveSourceResult	describeLiveSource(DescribeLiveSourceRequest describeLiveSourceRequest) The live source to describe.
DescribeProgramResult	describeProgram(DescribeProgramRequest describeProgramRequest) Describes a program within a channel.
DescribeSourceLocationResult	describeSourceLocation(DescribeSourceLocationRequest describeSourceLocationRequest) Describes a source location.
DescribeVodSourceResult	describeVodSource(DescribeVodSourceRequest describeVodSourceRequest) Provides details about a specific video on demand (VOD) source in a specific source location.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetChannelPolicyResult	getChannelPolicy(GetChannelPolicyRequest getChannelPolicyRequest) Returns the channel's IAM policy.
GetChannelScheduleResult	getChannelSchedule(GetChannelScheduleRequest getChannelScheduleRequest) Retrieves information about your channel's schedule.
GetPlaybackConfigurationResult	getPlaybackConfiguration(GetPlaybackConfigurationRequest getPlaybackConfigurationRequest) Retrieves a playback configuration.
GetPrefetchScheduleResult	getPrefetchSchedule(GetPrefetchScheduleRequest getPrefetchScheduleRequest) Retrieves a prefetch schedule for a playback configuration.
ListAlertsResult	listAlerts(ListAlertsRequest listAlertsRequest) Lists the alerts that are associated with a MediaTailor channel assembly resource.
ListChannelsResult	listChannels(ListChannelsRequest listChannelsRequest) Retrieves information about the channels that are associated with the current AWS account.
ListLiveSourcesResult	listLiveSources(ListLiveSourcesRequest listLiveSourcesRequest) Lists the live sources contained in a source location.
ListPlaybackConfigurationsResult	listPlaybackConfigurations(ListPlaybackConfigurationsRequest listPlaybackConfigurationsRequest) Retrieves existing playback configurations.
ListPrefetchSchedulesResult	listPrefetchSchedules(ListPrefetchSchedulesRequest listPrefetchSchedulesRequest) Lists the prefetch schedules for a playback configuration.
ListSourceLocationsResult	listSourceLocations(ListSourceLocationsRequest listSourceLocationsRequest) Lists the source locations for a channel.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) A list of tags that are associated with this resource.
ListVodSourcesResult	listVodSources(ListVodSourcesRequest listVodSourcesRequest) Lists the VOD sources contained in a source location.
PutChannelPolicyResult	putChannelPolicy(PutChannelPolicyRequest putChannelPolicyRequest) Creates an IAM policy for the channel.
PutPlaybackConfigurationResult	putPlaybackConfiguration(PutPlaybackConfigurationRequest putPlaybackConfigurationRequest) Creates a playback configuration.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartChannelResult	startChannel(StartChannelRequest startChannelRequest) Starts a channel.
StopChannelResult	stopChannel(StopChannelRequest stopChannelRequest) Stops a channel.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) The resource to tag.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) The resource to untag.
UpdateChannelResult	updateChannel(UpdateChannelRequest updateChannelRequest) Updates a channel.
UpdateLiveSourceResult	updateLiveSource(UpdateLiveSourceRequest updateLiveSourceRequest) Updates a live source's configuration.
UpdateProgramResult	updateProgram(UpdateProgramRequest updateProgramRequest) Updates a program within a channel.
UpdateSourceLocationResult	updateSourceLocation(UpdateSourceLocationRequest updateSourceLocationRequest) Updates a source location.
UpdateVodSourceResult	updateVodSource(UpdateVodSourceRequest updateVodSourceRequest) Updates a VOD source's configuration.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

configureLogsForChannel

ConfigureLogsForChannelResult configureLogsForChannel(ConfigureLogsForChannelRequest configureLogsForChannelRequest)

Configures Amazon CloudWatch log settings for a channel.

Parameters:

configureLogsForChannelRequest -

Returns:

Result of the ConfigureLogsForChannel operation returned by the service.

See Also:

AWS API Documentation

configureLogsForPlaybackConfiguration

ConfigureLogsForPlaybackConfigurationResult configureLogsForPlaybackConfiguration(ConfigureLogsForPlaybackConfigurationRequest configureLogsForPlaybackConfigurationRequest)

Amazon CloudWatch log settings for a playback configuration.

Parameters:

configureLogsForPlaybackConfigurationRequest - Configures Amazon CloudWatch log settings for a playback configuration.

Returns:

Result of the ConfigureLogsForPlaybackConfiguration operation returned by the service.

See Also:

AWS API Documentation

createChannel

CreateChannelResult createChannel(CreateChannelRequest createChannelRequest)

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

Parameters:

createChannelRequest -

Returns:

Result of the CreateChannel operation returned by the service.

See Also:

AWS API Documentation

createLiveSource

CreateLiveSourceResult createLiveSource(CreateLiveSourceRequest createLiveSourceRequest)

The live source configuration.

Parameters:

createLiveSourceRequest -

Returns:

Result of the CreateLiveSource operation returned by the service.

See Also:

AWS API Documentation

createPrefetchSchedule

CreatePrefetchScheduleResult createPrefetchSchedule(CreatePrefetchScheduleRequest createPrefetchScheduleRequest)

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.

Parameters:

createPrefetchScheduleRequest -

Returns:

Result of the CreatePrefetchSchedule operation returned by the service.

See Also:

AWS API Documentation

createProgram

CreateProgramResult createProgram(CreateProgramRequest createProgramRequest)

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

Parameters:

createProgramRequest -

Returns:

Result of the CreateProgram operation returned by the service.

See Also:

AWS API Documentation

createSourceLocation

CreateSourceLocationResult createSourceLocation(CreateSourceLocationRequest createSourceLocationRequest)

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.

Parameters:

createSourceLocationRequest -

Returns:

Result of the CreateSourceLocation operation returned by the service.

See Also:

AWS API Documentation

createVodSource

CreateVodSourceResult createVodSource(CreateVodSourceRequest createVodSourceRequest)

The VOD source configuration parameters.

Parameters:

createVodSourceRequest -

Returns:

Result of the CreateVodSource operation returned by the service.

See Also:

AWS API Documentation

deleteChannel

DeleteChannelResult deleteChannel(DeleteChannelRequest deleteChannelRequest)

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

Parameters:

deleteChannelRequest -

Returns:

Result of the DeleteChannel operation returned by the service.

See Also:

AWS API Documentation

deleteChannelPolicy

DeleteChannelPolicyResult deleteChannelPolicy(DeleteChannelPolicyRequest deleteChannelPolicyRequest)

The channel policy to delete.

Parameters:

deleteChannelPolicyRequest -

Returns:

Result of the DeleteChannelPolicy operation returned by the service.

See Also:

AWS API Documentation

deleteLiveSource

DeleteLiveSourceResult deleteLiveSource(DeleteLiveSourceRequest deleteLiveSourceRequest)

The live source to delete.

Parameters:

deleteLiveSourceRequest -

Returns:

Result of the DeleteLiveSource operation returned by the service.

See Also:

AWS API Documentation

deletePlaybackConfiguration

DeletePlaybackConfigurationResult deletePlaybackConfiguration(DeletePlaybackConfigurationRequest deletePlaybackConfigurationRequest)

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

Parameters:

deletePlaybackConfigurationRequest -

Returns:

Result of the DeletePlaybackConfiguration operation returned by the service.

See Also:

AWS API Documentation

deletePrefetchSchedule

DeletePrefetchScheduleResult deletePrefetchSchedule(DeletePrefetchScheduleRequest deletePrefetchScheduleRequest)

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.

Parameters:

deletePrefetchScheduleRequest -

Returns:

Result of the DeletePrefetchSchedule operation returned by the service.

See Also:

AWS API Documentation

deleteProgram

DeleteProgramResult deleteProgram(DeleteProgramRequest deleteProgramRequest)

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

Parameters:

deleteProgramRequest -

Returns:

Result of the DeleteProgram operation returned by the service.

See Also:

AWS API Documentation

deleteSourceLocation

DeleteSourceLocationResult deleteSourceLocation(DeleteSourceLocationRequest deleteSourceLocationRequest)

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.

Parameters:

deleteSourceLocationRequest -

Returns:

Result of the DeleteSourceLocation operation returned by the service.

See Also:

AWS API Documentation

deleteVodSource

DeleteVodSourceResult deleteVodSource(DeleteVodSourceRequest deleteVodSourceRequest)

The video on demand (VOD) source to delete.

Parameters:

deleteVodSourceRequest -

Returns:

Result of the DeleteVodSource operation returned by the service.

See Also:

AWS API Documentation

describeChannel

DescribeChannelResult describeChannel(DescribeChannelRequest describeChannelRequest)

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

Parameters:

describeChannelRequest -

Returns:

Result of the DescribeChannel operation returned by the service.

See Also:

AWS API Documentation

describeLiveSource

DescribeLiveSourceResult describeLiveSource(DescribeLiveSourceRequest describeLiveSourceRequest)

The live source to describe.

Parameters:

describeLiveSourceRequest -

Returns:

Result of the DescribeLiveSource operation returned by the service.

See Also:

AWS API Documentation

describeProgram

DescribeProgramResult describeProgram(DescribeProgramRequest describeProgramRequest)

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

Parameters:

describeProgramRequest -

Returns:

Result of the DescribeProgram operation returned by the service.

See Also:

AWS API Documentation

describeSourceLocation

DescribeSourceLocationResult describeSourceLocation(DescribeSourceLocationRequest describeSourceLocationRequest)

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.

Parameters:

describeSourceLocationRequest -

Returns:

Result of the DescribeSourceLocation operation returned by the service.

See Also:

AWS API Documentation

describeVodSource

DescribeVodSourceResult describeVodSource(DescribeVodSourceRequest describeVodSourceRequest)

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

Parameters:

describeVodSourceRequest -

Returns:

Result of the DescribeVodSource operation returned by the service.

See Also:

AWS API Documentation

getChannelPolicy

GetChannelPolicyResult getChannelPolicy(GetChannelPolicyRequest getChannelPolicyRequest)

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

Parameters:

getChannelPolicyRequest -

Returns:

Result of the GetChannelPolicy operation returned by the service.

See Also:

AWS API Documentation

getChannelSchedule

GetChannelScheduleResult getChannelSchedule(GetChannelScheduleRequest getChannelScheduleRequest)

Retrieves information about your channel's schedule.

Parameters:

getChannelScheduleRequest -

Returns:

Result of the GetChannelSchedule operation returned by the service.

See Also:

AWS API Documentation

getPlaybackConfiguration

GetPlaybackConfigurationResult getPlaybackConfiguration(GetPlaybackConfigurationRequest getPlaybackConfigurationRequest)

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

Parameters:

getPlaybackConfigurationRequest -

Returns:

Result of the GetPlaybackConfiguration operation returned by the service.

See Also:

AWS API Documentation

getPrefetchSchedule

GetPrefetchScheduleResult getPrefetchSchedule(GetPrefetchScheduleRequest getPrefetchScheduleRequest)

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.

Parameters:

getPrefetchScheduleRequest -

Returns:

Result of the GetPrefetchSchedule operation returned by the service.

See Also:

AWS API Documentation

listAlerts

ListAlertsResult listAlerts(ListAlertsRequest listAlertsRequest)

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

Parameters:

listAlertsRequest -

Returns:

Result of the ListAlerts operation returned by the service.

See Also:

AWS API Documentation

listChannels

ListChannelsResult listChannels(ListChannelsRequest listChannelsRequest)

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

Parameters:

listChannelsRequest -

Returns:

Result of the ListChannels operation returned by the service.

See Also:

AWS API Documentation

listLiveSources

ListLiveSourcesResult listLiveSources(ListLiveSourcesRequest listLiveSourcesRequest)

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

Parameters:

listLiveSourcesRequest -

Returns:

Result of the ListLiveSources operation returned by the service.

See Also:

AWS API Documentation

listPlaybackConfigurations

ListPlaybackConfigurationsResult listPlaybackConfigurations(ListPlaybackConfigurationsRequest listPlaybackConfigurationsRequest)

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

Parameters:

listPlaybackConfigurationsRequest -

Returns:

Result of the ListPlaybackConfigurations operation returned by the service.

See Also:

AWS API Documentation

listPrefetchSchedules

ListPrefetchSchedulesResult listPrefetchSchedules(ListPrefetchSchedulesRequest listPrefetchSchedulesRequest)

Lists the prefetch schedules for a playback configuration.

Parameters:

listPrefetchSchedulesRequest -

Returns:

Result of the ListPrefetchSchedules operation returned by the service.

See Also:

AWS API Documentation

listSourceLocations

ListSourceLocationsResult listSourceLocations(ListSourceLocationsRequest listSourceLocationsRequest)

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

Parameters:

listSourceLocationsRequest -

Returns:

Result of the ListSourceLocations operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

BadRequestException - A request contains unexpected data.

See Also:

AWS API Documentation

listVodSources

ListVodSourcesResult listVodSources(ListVodSourcesRequest listVodSourcesRequest)

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

Parameters:

listVodSourcesRequest -

Returns:

Result of the ListVodSources operation returned by the service.

See Also:

AWS API Documentation

putChannelPolicy

PutChannelPolicyResult putChannelPolicy(PutChannelPolicyRequest putChannelPolicyRequest)

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

Parameters:

putChannelPolicyRequest -

Returns:

Result of the PutChannelPolicy operation returned by the service.

See Also:

AWS API Documentation

putPlaybackConfiguration

PutPlaybackConfigurationResult putPlaybackConfiguration(PutPlaybackConfigurationRequest putPlaybackConfigurationRequest)

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

Parameters:

putPlaybackConfigurationRequest -

Returns:

Result of the PutPlaybackConfiguration operation returned by the service.

See Also:

AWS API Documentation

startChannel

StartChannelResult startChannel(StartChannelRequest startChannelRequest)

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

Parameters:

startChannelRequest -

Returns:

Result of the StartChannel operation returned by the service.

See Also:

AWS API Documentation

stopChannel

StopChannelResult stopChannel(StopChannelRequest stopChannelRequest)

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

Parameters:

stopChannelRequest -

Returns:

Result of the StopChannel operation returned by the service.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - A request contains unexpected data.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

The resource to untag.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

BadRequestException - A request contains unexpected data.

See Also:

AWS API Documentation

updateChannel

UpdateChannelResult updateChannel(UpdateChannelRequest updateChannelRequest)

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

Parameters:

updateChannelRequest -

Returns:

Result of the UpdateChannel operation returned by the service.

See Also:

AWS API Documentation

updateLiveSource

UpdateLiveSourceResult updateLiveSource(UpdateLiveSourceRequest updateLiveSourceRequest)

Updates a live source's configuration.

Parameters:

updateLiveSourceRequest -

Returns:

Result of the UpdateLiveSource operation returned by the service.

See Also:

AWS API Documentation

updateProgram

UpdateProgramResult updateProgram(UpdateProgramRequest updateProgramRequest)

Updates a program within a channel.

Parameters:

updateProgramRequest -

Returns:

Result of the UpdateProgram operation returned by the service.

See Also:

AWS API Documentation

updateSourceLocation

UpdateSourceLocationResult updateSourceLocation(UpdateSourceLocationRequest updateSourceLocationRequest)

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.

Parameters:

updateSourceLocationRequest -

Returns:

Result of the UpdateSourceLocation operation returned by the service.

See Also:

AWS API Documentation

updateVodSource

UpdateVodSourceResult updateVodSource(UpdateVodSourceRequest updateVodSourceRequest)

Updates a VOD source's configuration.

Parameters:

updateVodSourceRequest -

Returns:

Result of the UpdateVodSource operation returned by the service.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.