@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_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSMediaTailorClientBuilder builder()
public ConfigureLogsForChannelResult configureLogsForChannel(ConfigureLogsForChannelRequest request)
Configures Amazon CloudWatch log settings for a channel.
configureLogsForChannel
in interface AWSMediaTailor
configureLogsForChannelRequest
- public ConfigureLogsForPlaybackConfigurationResult configureLogsForPlaybackConfiguration(ConfigureLogsForPlaybackConfigurationRequest request)
Amazon CloudWatch log settings for a playback configuration.
configureLogsForPlaybackConfiguration
in interface AWSMediaTailor
configureLogsForPlaybackConfigurationRequest
- 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 AWSMediaTailor
createChannelRequest
- public CreateLiveSourceResult createLiveSource(CreateLiveSourceRequest request)
The live source configuration.
createLiveSource
in interface AWSMediaTailor
createLiveSourceRequest
- 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 AWSMediaTailor
createPrefetchScheduleRequest
- 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 AWSMediaTailor
createProgramRequest
- 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 AWSMediaTailor
createSourceLocationRequest
- public CreateVodSourceResult createVodSource(CreateVodSourceRequest request)
The VOD source configuration parameters.
createVodSource
in interface AWSMediaTailor
createVodSourceRequest
- 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 AWSMediaTailor
deleteChannelRequest
- public DeleteChannelPolicyResult deleteChannelPolicy(DeleteChannelPolicyRequest request)
The channel policy to delete.
deleteChannelPolicy
in interface AWSMediaTailor
deleteChannelPolicyRequest
- public DeleteLiveSourceResult deleteLiveSource(DeleteLiveSourceRequest request)
The live source to delete.
deleteLiveSource
in interface AWSMediaTailor
deleteLiveSourceRequest
- 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 AWSMediaTailor
deletePlaybackConfigurationRequest
- 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 AWSMediaTailor
deletePrefetchScheduleRequest
- 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 AWSMediaTailor
deleteProgramRequest
- 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 AWSMediaTailor
deleteSourceLocationRequest
- public DeleteVodSourceResult deleteVodSource(DeleteVodSourceRequest request)
The video on demand (VOD) source to delete.
deleteVodSource
in interface AWSMediaTailor
deleteVodSourceRequest
- 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 AWSMediaTailor
describeChannelRequest
- public DescribeLiveSourceResult describeLiveSource(DescribeLiveSourceRequest request)
The live source to describe.
describeLiveSource
in interface AWSMediaTailor
describeLiveSourceRequest
- 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 AWSMediaTailor
describeProgramRequest
- 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 AWSMediaTailor
describeSourceLocationRequest
- public DescribeVodSourceResult describeVodSource(DescribeVodSourceRequest request)
Provides details about a specific video on demand (VOD) source in a specific source location.
describeVodSource
in interface AWSMediaTailor
describeVodSourceRequest
- public GetChannelPolicyResult getChannelPolicy(GetChannelPolicyRequest request)
Returns the channel's IAM policy. IAM policies are used to control access to your channel.
getChannelPolicy
in interface AWSMediaTailor
getChannelPolicyRequest
- public GetChannelScheduleResult getChannelSchedule(GetChannelScheduleRequest request)
Retrieves information about your channel's schedule.
getChannelSchedule
in interface AWSMediaTailor
getChannelScheduleRequest
- 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 AWSMediaTailor
getPlaybackConfigurationRequest
- 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 AWSMediaTailor
getPrefetchScheduleRequest
- public ListAlertsResult listAlerts(ListAlertsRequest request)
Lists the alerts that are associated with a MediaTailor channel assembly resource.
listAlerts
in interface AWSMediaTailor
listAlertsRequest
- public ListChannelsResult listChannels(ListChannelsRequest request)
Retrieves information about the channels that are associated with the current AWS account.
listChannels
in interface AWSMediaTailor
listChannelsRequest
- public ListLiveSourcesResult listLiveSources(ListLiveSourcesRequest request)
Lists the live sources contained in a source location. A source represents a piece of content.
listLiveSources
in interface AWSMediaTailor
listLiveSourcesRequest
- 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 AWSMediaTailor
listPlaybackConfigurationsRequest
- public ListPrefetchSchedulesResult listPrefetchSchedules(ListPrefetchSchedulesRequest request)
Lists the prefetch schedules for a playback configuration.
listPrefetchSchedules
in interface AWSMediaTailor
listPrefetchSchedulesRequest
- 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 AWSMediaTailor
listSourceLocationsRequest
- 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 AWSMediaTailor
listTagsForResourceRequest
- 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 AWSMediaTailor
listVodSourcesRequest
- 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 AWSMediaTailor
putChannelPolicyRequest
- 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 AWSMediaTailor
putPlaybackConfigurationRequest
- 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 AWSMediaTailor
startChannelRequest
- 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 AWSMediaTailor
stopChannelRequest
- 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 AWSMediaTailor
tagResourceRequest
- BadRequestException
- A request contains unexpected data.public UntagResourceResult untagResource(UntagResourceRequest request)
The resource to untag.
untagResource
in interface AWSMediaTailor
untagResourceRequest
- 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 AWSMediaTailor
updateChannelRequest
- public UpdateLiveSourceResult updateLiveSource(UpdateLiveSourceRequest request)
Updates a live source's configuration.
updateLiveSource
in interface AWSMediaTailor
updateLiveSourceRequest
- public UpdateProgramResult updateProgram(UpdateProgramRequest request)
Updates a program within a channel.
updateProgram
in interface AWSMediaTailor
updateProgramRequest
- 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 AWSMediaTailor
updateSourceLocationRequest
- public UpdateVodSourceResult updateVodSource(UpdateVodSourceRequest request)
Updates a VOD source's configuration.
updateVodSource
in interface AWSMediaTailor
updateVodSourceRequest
- 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 AWSMediaTailor
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSMediaTailor
shutdown
in class AmazonWebServiceClient