@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
Modifier and Type | Method and Description |
---|---|
static AWSMediaTailorClientBuilder |
builder() |
ConfigureLogsForPlaybackConfigurationResult |
configureLogsForPlaybackConfiguration(ConfigureLogsForPlaybackConfigurationRequest request)
Configures Amazon CloudWatch log settings for a playback configuration.
|
CreateChannelResult |
createChannel(CreateChannelRequest request)
Creates a channel.
|
CreateLiveSourceResult |
createLiveSource(CreateLiveSourceRequest request)
Creates name for a specific live source in a source location.
|
CreatePrefetchScheduleResult |
createPrefetchSchedule(CreatePrefetchScheduleRequest request)
Creates a new prefetch schedule for the specified playback configuration.
|
CreateProgramResult |
createProgram(CreateProgramRequest request)
Creates a program.
|
CreateSourceLocationResult |
createSourceLocation(CreateSourceLocationRequest request)
Creates a source location on a specific channel.
|
CreateVodSourceResult |
createVodSource(CreateVodSourceRequest request)
Creates name for a specific VOD source in a source location.
|
DeleteChannelResult |
deleteChannel(DeleteChannelRequest request)
Deletes a channel.
|
DeleteChannelPolicyResult |
deleteChannelPolicy(DeleteChannelPolicyRequest request)
Deletes a channel's IAM policy.
|
DeleteLiveSourceResult |
deleteLiveSource(DeleteLiveSourceRequest request)
Deletes a specific live source in a specific source location.
|
DeletePlaybackConfigurationResult |
deletePlaybackConfiguration(DeletePlaybackConfigurationRequest request)
Deletes the playback configuration for the specified name.
|
DeletePrefetchScheduleResult |
deletePrefetchSchedule(DeletePrefetchScheduleRequest request)
Deletes a prefetch schedule for a specific playback configuration.
|
DeleteProgramResult |
deleteProgram(DeleteProgramRequest request)
Deletes a specific program on a specific channel.
|
DeleteSourceLocationResult |
deleteSourceLocation(DeleteSourceLocationRequest request)
Deletes a source location on a specific channel.
|
DeleteVodSourceResult |
deleteVodSource(DeleteVodSourceRequest request)
Deletes a specific VOD source in a specific source location.
|
DescribeChannelResult |
describeChannel(DescribeChannelRequest request)
Describes the properties of a specific channel.
|
DescribeLiveSourceResult |
describeLiveSource(DescribeLiveSourceRequest request)
Provides details about a specific live source in a specific source location.
|
DescribeProgramResult |
describeProgram(DescribeProgramRequest request)
Retrieves the properties of the requested program.
|
DescribeSourceLocationResult |
describeSourceLocation(DescribeSourceLocationRequest request)
Retrieves the properties of the requested source location.
|
DescribeVodSourceResult |
describeVodSource(DescribeVodSourceRequest request)
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 request)
Retrieves information about a channel's IAM policy.
|
GetChannelScheduleResult |
getChannelSchedule(GetChannelScheduleRequest request)
Retrieves information about your channel's schedule.
|
GetPlaybackConfigurationResult |
getPlaybackConfiguration(GetPlaybackConfigurationRequest request)
Returns the playback configuration for the specified name.
|
GetPrefetchScheduleResult |
getPrefetchSchedule(GetPrefetchScheduleRequest request)
Returns information about the prefetch schedule for a specific playback configuration.
|
ListAlertsResult |
listAlerts(ListAlertsRequest request)
Returns a list of alerts for the given resource.
|
ListChannelsResult |
listChannels(ListChannelsRequest request)
Retrieves a list of channels that are associated with this account.
|
ListLiveSourcesResult |
listLiveSources(ListLiveSourcesRequest request)
lists all the live sources in a source location.
|
ListPlaybackConfigurationsResult |
listPlaybackConfigurations(ListPlaybackConfigurationsRequest request)
Returns a list of the playback configurations defined in AWS Elemental MediaTailor.
|
ListPrefetchSchedulesResult |
listPrefetchSchedules(ListPrefetchSchedulesRequest request)
Creates a new prefetch schedule.
|
ListSourceLocationsResult |
listSourceLocations(ListSourceLocationsRequest request)
Retrieves a list of source locations.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags assigned to the specified playback configuration resource.
|
ListVodSourcesResult |
listVodSources(ListVodSourcesRequest request)
Lists all the VOD sources in a source location.
|
PutChannelPolicyResult |
putChannelPolicy(PutChannelPolicyRequest request)
Creates an IAM policy for the channel.
|
PutPlaybackConfigurationResult |
putPlaybackConfiguration(PutPlaybackConfigurationRequest request)
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 request)
Starts a specific channel.
|
StopChannelResult |
stopChannel(StopChannelRequest request)
Stops a specific channel.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds tags to the specified playback configuration resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from the specified playback configuration resource.
|
UpdateChannelResult |
updateChannel(UpdateChannelRequest request)
Updates an existing channel.
|
UpdateLiveSourceResult |
updateLiveSource(UpdateLiveSourceRequest request)
Updates a specific live source in a specific source location.
|
UpdateSourceLocationResult |
updateSourceLocation(UpdateSourceLocationRequest request)
Updates a source location on a specific channel.
|
UpdateVodSourceResult |
updateVodSource(UpdateVodSourceRequest request)
Updates a specific VOD source in a specific source location.
|
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 ConfigureLogsForPlaybackConfigurationResult configureLogsForPlaybackConfiguration(ConfigureLogsForPlaybackConfigurationRequest request)
Configures 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.
createChannel
in interface AWSMediaTailor
createChannelRequest
- public CreateLiveSourceResult createLiveSource(CreateLiveSourceRequest request)
Creates name for a specific live source in a source location.
createLiveSource
in interface AWSMediaTailor
createLiveSourceRequest
- public CreatePrefetchScheduleResult createPrefetchSchedule(CreatePrefetchScheduleRequest request)
Creates a new prefetch schedule for the specified playback configuration.
createPrefetchSchedule
in interface AWSMediaTailor
createPrefetchScheduleRequest
- public CreateProgramResult createProgram(CreateProgramRequest request)
Creates a program.
createProgram
in interface AWSMediaTailor
createProgramRequest
- public CreateSourceLocationResult createSourceLocation(CreateSourceLocationRequest request)
Creates a source location on a specific channel.
createSourceLocation
in interface AWSMediaTailor
createSourceLocationRequest
- public CreateVodSourceResult createVodSource(CreateVodSourceRequest request)
Creates name for a specific VOD source in a source location.
createVodSource
in interface AWSMediaTailor
createVodSourceRequest
- public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
Deletes a channel. You must stop the channel before it can be deleted.
deleteChannel
in interface AWSMediaTailor
deleteChannelRequest
- public DeleteChannelPolicyResult deleteChannelPolicy(DeleteChannelPolicyRequest request)
Deletes a channel's IAM policy.
deleteChannelPolicy
in interface AWSMediaTailor
deleteChannelPolicyRequest
- public DeleteLiveSourceResult deleteLiveSource(DeleteLiveSourceRequest request)
Deletes a specific live source in a specific source location.
deleteLiveSource
in interface AWSMediaTailor
deleteLiveSourceRequest
- public DeletePlaybackConfigurationResult deletePlaybackConfiguration(DeletePlaybackConfigurationRequest request)
Deletes the playback configuration for the specified name.
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.
deletePrefetchSchedule
in interface AWSMediaTailor
deletePrefetchScheduleRequest
- public DeleteProgramResult deleteProgram(DeleteProgramRequest request)
Deletes a specific program on a specific channel.
deleteProgram
in interface AWSMediaTailor
deleteProgramRequest
- public DeleteSourceLocationResult deleteSourceLocation(DeleteSourceLocationRequest request)
Deletes a source location on a specific channel.
deleteSourceLocation
in interface AWSMediaTailor
deleteSourceLocationRequest
- public DeleteVodSourceResult deleteVodSource(DeleteVodSourceRequest request)
Deletes a specific VOD source in a specific source location.
deleteVodSource
in interface AWSMediaTailor
deleteVodSourceRequest
- public DescribeChannelResult describeChannel(DescribeChannelRequest request)
Describes the properties of a specific channel.
describeChannel
in interface AWSMediaTailor
describeChannelRequest
- public DescribeLiveSourceResult describeLiveSource(DescribeLiveSourceRequest request)
Provides details about a specific live source in a specific source location.
describeLiveSource
in interface AWSMediaTailor
describeLiveSourceRequest
- public DescribeProgramResult describeProgram(DescribeProgramRequest request)
Retrieves the properties of the requested program.
describeProgram
in interface AWSMediaTailor
describeProgramRequest
- public DescribeSourceLocationResult describeSourceLocation(DescribeSourceLocationRequest request)
Retrieves the properties of the requested source location.
describeSourceLocation
in interface AWSMediaTailor
describeSourceLocationRequest
- public DescribeVodSourceResult describeVodSource(DescribeVodSourceRequest request)
Provides details about a specific VOD source in a specific source location.
describeVodSource
in interface AWSMediaTailor
describeVodSourceRequest
- public GetChannelPolicyResult getChannelPolicy(GetChannelPolicyRequest request)
Retrieves information about a channel's IAM policy.
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)
Returns the playback configuration for the specified name.
getPlaybackConfiguration
in interface AWSMediaTailor
getPlaybackConfigurationRequest
- public GetPrefetchScheduleResult getPrefetchSchedule(GetPrefetchScheduleRequest request)
Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.
getPrefetchSchedule
in interface AWSMediaTailor
getPrefetchScheduleRequest
- public ListAlertsResult listAlerts(ListAlertsRequest request)
Returns a list of alerts for the given resource.
listAlerts
in interface AWSMediaTailor
listAlertsRequest
- public ListChannelsResult listChannels(ListChannelsRequest request)
Retrieves a list of channels that are associated with this account.
listChannels
in interface AWSMediaTailor
listChannelsRequest
- public ListLiveSourcesResult listLiveSources(ListLiveSourcesRequest request)
lists all the live sources in a source location.
listLiveSources
in interface AWSMediaTailor
listLiveSourcesRequest
- public ListPlaybackConfigurationsResult listPlaybackConfigurations(ListPlaybackConfigurationsRequest request)
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.
listPlaybackConfigurations
in interface AWSMediaTailor
listPlaybackConfigurationsRequest
- public ListPrefetchSchedulesResult listPrefetchSchedules(ListPrefetchSchedulesRequest request)
Creates a new prefetch schedule.
listPrefetchSchedules
in interface AWSMediaTailor
listPrefetchSchedulesRequest
- public ListSourceLocationsResult listSourceLocations(ListSourceLocationsRequest request)
Retrieves a list of source locations.
listSourceLocations
in interface AWSMediaTailor
listSourceLocationsRequest
- public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags assigned to the specified playback configuration resource.
listTagsForResource
in interface AWSMediaTailor
listTagsForResourceRequest
- BadRequestException
- One or more parameters in this request aren't valid.public ListVodSourcesResult listVodSources(ListVodSourcesRequest request)
Lists all the VOD sources in a source location.
listVodSources
in interface AWSMediaTailor
listVodSourcesRequest
- public PutChannelPolicyResult putChannelPolicy(PutChannelPolicyRequest request)
Creates an IAM policy for the channel.
putChannelPolicy
in interface AWSMediaTailor
putChannelPolicyRequest
- public PutPlaybackConfigurationResult putPlaybackConfiguration(PutPlaybackConfigurationRequest request)
Adds a new playback configuration to AWS Elemental MediaTailor.
putPlaybackConfiguration
in interface AWSMediaTailor
putPlaybackConfigurationRequest
- public StartChannelResult startChannel(StartChannelRequest request)
Starts a specific channel.
startChannel
in interface AWSMediaTailor
startChannelRequest
- public StopChannelResult stopChannel(StopChannelRequest request)
Stops a specific channel.
stopChannel
in interface AWSMediaTailor
stopChannelRequest
- public TagResourceResult tagResource(TagResourceRequest request)
Adds tags to the specified playback configuration resource. You can specify one or more tags to add.
tagResource
in interface AWSMediaTailor
tagResourceRequest
- BadRequestException
- One or more parameters in this request aren't valid.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.
untagResource
in interface AWSMediaTailor
untagResourceRequest
- BadRequestException
- One or more parameters in this request aren't valid.public UpdateChannelResult updateChannel(UpdateChannelRequest request)
Updates an existing channel.
updateChannel
in interface AWSMediaTailor
updateChannelRequest
- public UpdateLiveSourceResult updateLiveSource(UpdateLiveSourceRequest request)
Updates a specific live source in a specific source location.
updateLiveSource
in interface AWSMediaTailor
updateLiveSourceRequest
- public UpdateSourceLocationResult updateSourceLocation(UpdateSourceLocationRequest request)
Updates a source location on a specific channel.
updateSourceLocation
in interface AWSMediaTailor
updateSourceLocationRequest
- public UpdateVodSourceResult updateVodSource(UpdateVodSourceRequest request)
Updates a specific VOD source in a specific source location.
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