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
CreateChannelResult	createChannel(CreateChannelRequest createChannelRequest) Creates a channel.
CreateProgramResult	createProgram(CreateProgramRequest createProgramRequest) Creates a program.
CreateSourceLocationResult	createSourceLocation(CreateSourceLocationRequest createSourceLocationRequest) Creates a source location on a specific channel.
CreateVodSourceResult	createVodSource(CreateVodSourceRequest createVodSourceRequest) Creates name for a specific VOD source in a source location.
DeleteChannelResult	deleteChannel(DeleteChannelRequest deleteChannelRequest) Deletes a channel.
DeleteChannelPolicyResult	deleteChannelPolicy(DeleteChannelPolicyRequest deleteChannelPolicyRequest) Deletes a channel's IAM policy.
DeletePlaybackConfigurationResult	deletePlaybackConfiguration(DeletePlaybackConfigurationRequest deletePlaybackConfigurationRequest) Deletes the playback configuration for the specified name.
DeleteProgramResult	deleteProgram(DeleteProgramRequest deleteProgramRequest) Deletes a specific program on a specific channel.
DeleteSourceLocationResult	deleteSourceLocation(DeleteSourceLocationRequest deleteSourceLocationRequest) Deletes a source location on a specific channel.
DeleteVodSourceResult	deleteVodSource(DeleteVodSourceRequest deleteVodSourceRequest) Deletes a specific VOD source in a specific source location.
DescribeChannelResult	describeChannel(DescribeChannelRequest describeChannelRequest) Describes the properties of a specific channel.
DescribeProgramResult	describeProgram(DescribeProgramRequest describeProgramRequest) Retrieves the properties of the requested program.
DescribeSourceLocationResult	describeSourceLocation(DescribeSourceLocationRequest describeSourceLocationRequest) Retrieves the properties of the requested source location.
DescribeVodSourceResult	describeVodSource(DescribeVodSourceRequest describeVodSourceRequest) Provides details about a specific 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) Retrieves information about a channel's IAM policy.
GetChannelScheduleResult	getChannelSchedule(GetChannelScheduleRequest getChannelScheduleRequest) Retrieves information about your channel's schedule.
GetPlaybackConfigurationResult	getPlaybackConfiguration(GetPlaybackConfigurationRequest getPlaybackConfigurationRequest) Returns the playback configuration for the specified name.
ListChannelsResult	listChannels(ListChannelsRequest listChannelsRequest) Retrieves a list of channels that are associated with this account.
ListPlaybackConfigurationsResult	listPlaybackConfigurations(ListPlaybackConfigurationsRequest listPlaybackConfigurationsRequest) Returns a list of the playback configurations defined in AWS Elemental MediaTailor.
ListSourceLocationsResult	listSourceLocations(ListSourceLocationsRequest listSourceLocationsRequest) Retrieves a list of source locations.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of the tags assigned to the specified playback configuration resource.
ListVodSourcesResult	listVodSources(ListVodSourcesRequest listVodSourcesRequest) Lists all the VOD sources in a source location.
PutChannelPolicyResult	putChannelPolicy(PutChannelPolicyRequest putChannelPolicyRequest) Creates an IAM policy for the channel.
PutPlaybackConfigurationResult	putPlaybackConfiguration(PutPlaybackConfigurationRequest putPlaybackConfigurationRequest) Adds a new playback configuration to AWS Elemental MediaTailor.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartChannelResult	startChannel(StartChannelRequest startChannelRequest) Starts a specific channel.
StopChannelResult	stopChannel(StopChannelRequest stopChannelRequest) Stops a specific channel.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds tags to the specified playback configuration resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the specified playback configuration resource.
UpdateChannelResult	updateChannel(UpdateChannelRequest updateChannelRequest) Updates an existing channel.
UpdateSourceLocationResult	updateSourceLocation(UpdateSourceLocationRequest updateSourceLocationRequest) Updates a source location on a specific channel.
UpdateVodSourceResult	updateVodSource(UpdateVodSourceRequest updateVodSourceRequest) Updates a specific VOD source in a specific source location.

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

createChannel

CreateChannelResult createChannel(CreateChannelRequest createChannelRequest)

Creates a channel.

Parameters:

createChannelRequest -

Returns:

Result of the CreateChannel operation returned by the service.

See Also:

AWS API Documentation

createProgram

CreateProgramResult createProgram(CreateProgramRequest createProgramRequest)

Creates a program.

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 on a specific channel.

Parameters:

createSourceLocationRequest -

Returns:

Result of the CreateSourceLocation operation returned by the service.

See Also:

AWS API Documentation

createVodSource

CreateVodSourceResult createVodSource(CreateVodSourceRequest createVodSourceRequest)

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

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. You must stop the channel before it can be deleted.

Parameters:

deleteChannelRequest -

Returns:

Result of the DeleteChannel operation returned by the service.

See Also:

AWS API Documentation

deleteChannelPolicy

DeleteChannelPolicyResult deleteChannelPolicy(DeleteChannelPolicyRequest deleteChannelPolicyRequest)

Deletes a channel's IAM policy.

Parameters:

deleteChannelPolicyRequest -

Returns:

Result of the DeleteChannelPolicy operation returned by the service.

See Also:

AWS API Documentation

deletePlaybackConfiguration

DeletePlaybackConfigurationResult deletePlaybackConfiguration(DeletePlaybackConfigurationRequest deletePlaybackConfigurationRequest)

Deletes the playback configuration for the specified name.

Parameters:

deletePlaybackConfigurationRequest -

Returns:

Result of the DeletePlaybackConfiguration operation returned by the service.

See Also:

AWS API Documentation

deleteProgram

DeleteProgramResult deleteProgram(DeleteProgramRequest deleteProgramRequest)

Deletes a specific program on a specific channel.

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 on a specific channel.

Parameters:

deleteSourceLocationRequest -

Returns:

Result of the DeleteSourceLocation operation returned by the service.

See Also:

AWS API Documentation

deleteVodSource

DeleteVodSourceResult deleteVodSource(DeleteVodSourceRequest deleteVodSourceRequest)

Deletes a specific VOD source in a specific source location.

Parameters:

deleteVodSourceRequest -

Returns:

Result of the DeleteVodSource operation returned by the service.

See Also:

AWS API Documentation

describeChannel

DescribeChannelResult describeChannel(DescribeChannelRequest describeChannelRequest)

Describes the properties of a specific channel.

Parameters:

describeChannelRequest -

Returns:

Result of the DescribeChannel operation returned by the service.

See Also:

AWS API Documentation

describeProgram

DescribeProgramResult describeProgram(DescribeProgramRequest describeProgramRequest)

Retrieves the properties of the requested program.

Parameters:

describeProgramRequest -

Returns:

Result of the DescribeProgram operation returned by the service.

See Also:

AWS API Documentation

describeSourceLocation

DescribeSourceLocationResult describeSourceLocation(DescribeSourceLocationRequest describeSourceLocationRequest)

Retrieves the properties of the requested source location.

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

Retrieves information about a channel's IAM policy.

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)

Returns the playback configuration for the specified name.

Parameters:

getPlaybackConfigurationRequest -

Returns:

Result of the GetPlaybackConfiguration operation returned by the service.

See Also:

AWS API Documentation

listChannels

ListChannelsResult listChannels(ListChannelsRequest listChannelsRequest)

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

Parameters:

listChannelsRequest -

Returns:

Result of the ListChannels operation returned by the service.

See Also:

AWS API Documentation

listPlaybackConfigurations

ListPlaybackConfigurationsResult listPlaybackConfigurations(ListPlaybackConfigurationsRequest listPlaybackConfigurationsRequest)

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.

Parameters:

listPlaybackConfigurationsRequest -

Returns:

Result of the ListPlaybackConfigurations operation returned by the service.

See Also:

AWS API Documentation

listSourceLocations

ListSourceLocationsResult listSourceLocations(ListSourceLocationsRequest listSourceLocationsRequest)

Retrieves a list of source locations.

Parameters:

listSourceLocationsRequest -

Returns:

Result of the ListSourceLocations operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

BadRequestException - Invalid request parameters.

See Also:

AWS API Documentation

listVodSources

ListVodSourcesResult listVodSources(ListVodSourcesRequest listVodSourcesRequest)

Lists all the VOD sources in a source location.

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.

Parameters:

putChannelPolicyRequest -

Returns:

Result of the PutChannelPolicy operation returned by the service.

See Also:

AWS API Documentation

putPlaybackConfiguration

PutPlaybackConfigurationResult putPlaybackConfiguration(PutPlaybackConfigurationRequest putPlaybackConfigurationRequest)

Adds a new playback configuration to 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 specific channel.

Parameters:

startChannelRequest -

Returns:

Result of the StartChannel operation returned by the service.

See Also:

AWS API Documentation

stopChannel

StopChannelResult stopChannel(StopChannelRequest stopChannelRequest)

Stops a specific channel.

Parameters:

stopChannelRequest -

Returns:

Result of the StopChannel operation returned by the service.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds tags to the specified playback configuration resource. You can specify one or more tags to add.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - Invalid request parameters.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

BadRequestException - Invalid request parameters.

See Also:

AWS API Documentation

updateChannel

UpdateChannelResult updateChannel(UpdateChannelRequest updateChannelRequest)

Updates an existing channel.

Parameters:

updateChannelRequest -

Returns:

Result of the UpdateChannel operation returned by the service.

See Also:

AWS API Documentation

updateSourceLocation

UpdateSourceLocationResult updateSourceLocation(UpdateSourceLocationRequest updateSourceLocationRequest)

Updates a source location on a specific channel.

Parameters:

updateSourceLocationRequest -

Returns:

Result of the UpdateSourceLocation operation returned by the service.

See Also:

AWS API Documentation

updateVodSource

UpdateVodSourceResult updateVodSource(UpdateVodSourceRequest updateVodSourceRequest)

Updates a specific VOD source in a specific source location.

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.