@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSMediaTailorClient extends AmazonWebServiceClient implements AWSMediaTailor
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).
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSMediaTailorClientBuilder builder()
public ConfigureLogsForChannelResult configureLogsForChannel(ConfigureLogsForChannelRequest request)
Configures Amazon CloudWatch log settings for a channel.
configureLogsForChannel in interface AWSMediaTailorconfigureLogsForChannelRequest - public ConfigureLogsForPlaybackConfigurationResult configureLogsForPlaybackConfiguration(ConfigureLogsForPlaybackConfigurationRequest request)
Amazon CloudWatch log settings for a playback configuration.
configureLogsForPlaybackConfiguration in interface AWSMediaTailorconfigureLogsForPlaybackConfigurationRequest - Configures Amazon CloudWatch log settings for a playback configuration.public CreateChannelResult createChannel(CreateChannelRequest request)
Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
createChannel in interface AWSMediaTailorcreateChannelRequest - public CreateLiveSourceResult createLiveSource(CreateLiveSourceRequest request)
The live source configuration.
createLiveSource in interface AWSMediaTailorcreateLiveSourceRequest - public CreatePrefetchScheduleResult createPrefetchSchedule(CreatePrefetchScheduleRequest request)
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.
createPrefetchSchedule in interface AWSMediaTailorcreatePrefetchScheduleRequest - public CreateProgramResult createProgram(CreateProgramRequest request)
Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
createProgram in interface AWSMediaTailorcreateProgramRequest - public CreateSourceLocationResult createSourceLocation(CreateSourceLocationRequest request)
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.
createSourceLocation in interface AWSMediaTailorcreateSourceLocationRequest - public CreateVodSourceResult createVodSource(CreateVodSourceRequest request)
The VOD source configuration parameters.
createVodSource in interface AWSMediaTailorcreateVodSourceRequest - public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
deleteChannel in interface AWSMediaTailordeleteChannelRequest - public DeleteChannelPolicyResult deleteChannelPolicy(DeleteChannelPolicyRequest request)
The channel policy to delete.
deleteChannelPolicy in interface AWSMediaTailordeleteChannelPolicyRequest - public DeleteLiveSourceResult deleteLiveSource(DeleteLiveSourceRequest request)
The live source to delete.
deleteLiveSource in interface AWSMediaTailordeleteLiveSourceRequest - public DeletePlaybackConfigurationResult deletePlaybackConfiguration(DeletePlaybackConfigurationRequest request)
Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
deletePlaybackConfiguration in interface AWSMediaTailordeletePlaybackConfigurationRequest - public DeletePrefetchScheduleResult deletePrefetchSchedule(DeletePrefetchScheduleRequest request)
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.
deletePrefetchSchedule in interface AWSMediaTailordeletePrefetchScheduleRequest - public DeleteProgramResult deleteProgram(DeleteProgramRequest request)
Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
deleteProgram in interface AWSMediaTailordeleteProgramRequest - public DeleteSourceLocationResult deleteSourceLocation(DeleteSourceLocationRequest request)
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.
deleteSourceLocation in interface AWSMediaTailordeleteSourceLocationRequest - public DeleteVodSourceResult deleteVodSource(DeleteVodSourceRequest request)
The video on demand (VOD) source to delete.
deleteVodSource in interface AWSMediaTailordeleteVodSourceRequest - public DescribeChannelResult describeChannel(DescribeChannelRequest request)
Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
describeChannel in interface AWSMediaTailordescribeChannelRequest - public DescribeLiveSourceResult describeLiveSource(DescribeLiveSourceRequest request)
The live source to describe.
describeLiveSource in interface AWSMediaTailordescribeLiveSourceRequest - public DescribeProgramResult describeProgram(DescribeProgramRequest request)
Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
describeProgram in interface AWSMediaTailordescribeProgramRequest - public DescribeSourceLocationResult describeSourceLocation(DescribeSourceLocationRequest request)
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.
describeSourceLocation in interface AWSMediaTailordescribeSourceLocationRequest - public DescribeVodSourceResult describeVodSource(DescribeVodSourceRequest request)
Provides details about a specific video on demand (VOD) source in a specific source location.
describeVodSource in interface AWSMediaTailordescribeVodSourceRequest - public GetChannelPolicyResult getChannelPolicy(GetChannelPolicyRequest request)
Returns the channel's IAM policy. IAM policies are used to control access to your channel.
getChannelPolicy in interface AWSMediaTailorgetChannelPolicyRequest - public GetChannelScheduleResult getChannelSchedule(GetChannelScheduleRequest request)
Retrieves information about your channel's schedule.
getChannelSchedule in interface AWSMediaTailorgetChannelScheduleRequest - public GetPlaybackConfigurationResult getPlaybackConfiguration(GetPlaybackConfigurationRequest request)
Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
getPlaybackConfiguration in interface AWSMediaTailorgetPlaybackConfigurationRequest - public GetPrefetchScheduleResult getPrefetchSchedule(GetPrefetchScheduleRequest request)
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.
getPrefetchSchedule in interface AWSMediaTailorgetPrefetchScheduleRequest - public ListAlertsResult listAlerts(ListAlertsRequest request)
Lists the alerts that are associated with a MediaTailor channel assembly resource.
listAlerts in interface AWSMediaTailorlistAlertsRequest - public ListChannelsResult listChannels(ListChannelsRequest request)
Retrieves information about the channels that are associated with the current AWS account.
listChannels in interface AWSMediaTailorlistChannelsRequest - public ListLiveSourcesResult listLiveSources(ListLiveSourcesRequest request)
Lists the live sources contained in a source location. A source represents a piece of content.
listLiveSources in interface AWSMediaTailorlistLiveSourcesRequest - public ListPlaybackConfigurationsResult listPlaybackConfigurations(ListPlaybackConfigurationsRequest request)
Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.
listPlaybackConfigurations in interface AWSMediaTailorlistPlaybackConfigurationsRequest - public ListPrefetchSchedulesResult listPrefetchSchedules(ListPrefetchSchedulesRequest request)
Lists the prefetch schedules for a playback configuration.
listPrefetchSchedules in interface AWSMediaTailorlistPrefetchSchedulesRequest - public ListSourceLocationsResult listSourceLocations(ListSourceLocationsRequest request)
Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.
listSourceLocations in interface AWSMediaTailorlistSourceLocationsRequest - public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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.
listTagsForResource in interface AWSMediaTailorlistTagsForResourceRequest - BadRequestException - A request contains unexpected data.public ListVodSourcesResult listVodSources(ListVodSourcesRequest request)
Lists the VOD sources contained in a source location. A source represents a piece of content.
listVodSources in interface AWSMediaTailorlistVodSourcesRequest - public PutChannelPolicyResult putChannelPolicy(PutChannelPolicyRequest request)
Creates an IAM policy for the channel. IAM policies are used to control access to your channel.
putChannelPolicy in interface AWSMediaTailorputChannelPolicyRequest - public PutPlaybackConfigurationResult putPlaybackConfiguration(PutPlaybackConfigurationRequest request)
Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
putPlaybackConfiguration in interface AWSMediaTailorputPlaybackConfigurationRequest - public StartChannelResult startChannel(StartChannelRequest request)
Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
startChannel in interface AWSMediaTailorstartChannelRequest - public StopChannelResult stopChannel(StopChannelRequest request)
Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
stopChannel in interface AWSMediaTailorstopChannelRequest - public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource in interface AWSMediaTailortagResourceRequest - BadRequestException - A request contains unexpected data.public UntagResourceResult untagResource(UntagResourceRequest request)
The resource to untag.
untagResource in interface AWSMediaTailoruntagResourceRequest - BadRequestException - A request contains unexpected data.public UpdateChannelResult updateChannel(UpdateChannelRequest request)
Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
updateChannel in interface AWSMediaTailorupdateChannelRequest - public UpdateLiveSourceResult updateLiveSource(UpdateLiveSourceRequest request)
Updates a live source's configuration.
updateLiveSource in interface AWSMediaTailorupdateLiveSourceRequest - public UpdateProgramResult updateProgram(UpdateProgramRequest request)
Updates a program within a channel.
updateProgram in interface AWSMediaTailorupdateProgramRequest - public UpdateSourceLocationResult updateSourceLocation(UpdateSourceLocationRequest request)
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.
updateSourceLocation in interface AWSMediaTailorupdateSourceLocationRequest - public UpdateVodSourceResult updateVodSource(UpdateVodSourceRequest request)
Updates a VOD source's configuration.
updateVodSource in interface AWSMediaTailorupdateVodSourceRequest - public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata in interface AWSMediaTailorrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSMediaTailorshutdown in class AmazonWebServiceClient