@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).
| Modifier and Type | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_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, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetprotected static final ClientConfigurationFactory configFactory
public static AWSMediaTailorClientBuilder builder()
public ConfigureLogsForPlaybackConfigurationResult configureLogsForPlaybackConfiguration(ConfigureLogsForPlaybackConfigurationRequest request)
Configures 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.
createChannel in interface AWSMediaTailorcreateChannelRequest - public CreateLiveSourceResult createLiveSource(CreateLiveSourceRequest request)
Creates name for a specific live source in a source location.
createLiveSource in interface AWSMediaTailorcreateLiveSourceRequest - public CreatePrefetchScheduleResult createPrefetchSchedule(CreatePrefetchScheduleRequest request)
Creates a new prefetch schedule for the specified playback configuration.
createPrefetchSchedule in interface AWSMediaTailorcreatePrefetchScheduleRequest - public CreateProgramResult createProgram(CreateProgramRequest request)
Creates a program.
createProgram in interface AWSMediaTailorcreateProgramRequest - public CreateSourceLocationResult createSourceLocation(CreateSourceLocationRequest request)
Creates a source location on a specific channel.
createSourceLocation in interface AWSMediaTailorcreateSourceLocationRequest - public CreateVodSourceResult createVodSource(CreateVodSourceRequest request)
Creates name for a specific VOD source in a source location.
createVodSource in interface AWSMediaTailorcreateVodSourceRequest - public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
Deletes a channel. You must stop the channel before it can be deleted.
deleteChannel in interface AWSMediaTailordeleteChannelRequest - public DeleteChannelPolicyResult deleteChannelPolicy(DeleteChannelPolicyRequest request)
Deletes a channel's IAM policy.
deleteChannelPolicy in interface AWSMediaTailordeleteChannelPolicyRequest - public DeleteLiveSourceResult deleteLiveSource(DeleteLiveSourceRequest request)
Deletes a specific live source in a specific source location.
deleteLiveSource in interface AWSMediaTailordeleteLiveSourceRequest - public DeletePlaybackConfigurationResult deletePlaybackConfiguration(DeletePlaybackConfigurationRequest request)
Deletes the playback configuration for the specified name.
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.
deletePrefetchSchedule in interface AWSMediaTailordeletePrefetchScheduleRequest - public DeleteProgramResult deleteProgram(DeleteProgramRequest request)
Deletes a specific program on a specific channel.
deleteProgram in interface AWSMediaTailordeleteProgramRequest - public DeleteSourceLocationResult deleteSourceLocation(DeleteSourceLocationRequest request)
Deletes a source location on a specific channel.
deleteSourceLocation in interface AWSMediaTailordeleteSourceLocationRequest - public DeleteVodSourceResult deleteVodSource(DeleteVodSourceRequest request)
Deletes a specific VOD source in a specific source location.
deleteVodSource in interface AWSMediaTailordeleteVodSourceRequest - public DescribeChannelResult describeChannel(DescribeChannelRequest request)
Describes the properties of a specific channel.
describeChannel in interface AWSMediaTailordescribeChannelRequest - public DescribeLiveSourceResult describeLiveSource(DescribeLiveSourceRequest request)
Provides details about a specific live source in a specific source location.
describeLiveSource in interface AWSMediaTailordescribeLiveSourceRequest - public DescribeProgramResult describeProgram(DescribeProgramRequest request)
Retrieves the properties of the requested program.
describeProgram in interface AWSMediaTailordescribeProgramRequest - public DescribeSourceLocationResult describeSourceLocation(DescribeSourceLocationRequest request)
Retrieves the properties of the requested source location.
describeSourceLocation in interface AWSMediaTailordescribeSourceLocationRequest - public DescribeVodSourceResult describeVodSource(DescribeVodSourceRequest request)
Provides details about a specific VOD source in a specific source location.
describeVodSource in interface AWSMediaTailordescribeVodSourceRequest - public GetChannelPolicyResult getChannelPolicy(GetChannelPolicyRequest request)
Retrieves information about a channel's IAM policy.
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)
Returns the playback configuration for the specified name.
getPlaybackConfiguration in interface AWSMediaTailorgetPlaybackConfigurationRequest - 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 AWSMediaTailorgetPrefetchScheduleRequest - public ListAlertsResult listAlerts(ListAlertsRequest request)
Returns a list of alerts for the given resource.
listAlerts in interface AWSMediaTailorlistAlertsRequest - public ListChannelsResult listChannels(ListChannelsRequest request)
Retrieves a list of channels that are associated with this account.
listChannels in interface AWSMediaTailorlistChannelsRequest - public ListLiveSourcesResult listLiveSources(ListLiveSourcesRequest request)
lists all the live sources in a source location.
listLiveSources in interface AWSMediaTailorlistLiveSourcesRequest - 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 AWSMediaTailorlistPlaybackConfigurationsRequest - public ListPrefetchSchedulesResult listPrefetchSchedules(ListPrefetchSchedulesRequest request)
Creates a new prefetch schedule.
listPrefetchSchedules in interface AWSMediaTailorlistPrefetchSchedulesRequest - public ListSourceLocationsResult listSourceLocations(ListSourceLocationsRequest request)
Retrieves a list of source locations.
listSourceLocations in interface AWSMediaTailorlistSourceLocationsRequest - public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags assigned to the specified playback configuration resource.
listTagsForResource in interface AWSMediaTailorlistTagsForResourceRequest - 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 AWSMediaTailorlistVodSourcesRequest - public PutChannelPolicyResult putChannelPolicy(PutChannelPolicyRequest request)
Creates an IAM policy for the channel.
putChannelPolicy in interface AWSMediaTailorputChannelPolicyRequest - public PutPlaybackConfigurationResult putPlaybackConfiguration(PutPlaybackConfigurationRequest request)
Adds a new playback configuration to AWS Elemental MediaTailor.
putPlaybackConfiguration in interface AWSMediaTailorputPlaybackConfigurationRequest - public StartChannelResult startChannel(StartChannelRequest request)
Starts a specific channel.
startChannel in interface AWSMediaTailorstartChannelRequest - public StopChannelResult stopChannel(StopChannelRequest request)
Stops a specific channel.
stopChannel in interface AWSMediaTailorstopChannelRequest - 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 AWSMediaTailortagResourceRequest - 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 AWSMediaTailoruntagResourceRequest - BadRequestException - One or more parameters in this request aren't valid.public UpdateChannelResult updateChannel(UpdateChannelRequest request)
Updates an existing channel.
updateChannel in interface AWSMediaTailorupdateChannelRequest - public UpdateLiveSourceResult updateLiveSource(UpdateLiveSourceRequest request)
Updates a specific live source in a specific source location.
updateLiveSource in interface AWSMediaTailorupdateLiveSourceRequest - public UpdateSourceLocationResult updateSourceLocation(UpdateSourceLocationRequest request)
Updates a source location on a specific channel.
updateSourceLocation in interface AWSMediaTailorupdateSourceLocationRequest - public UpdateVodSourceResult updateVodSource(UpdateVodSourceRequest request)
Updates a specific VOD source in a specific source location.
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()
AWSMediaTailorshutdown in interface AWSMediaTailorshutdown in class AmazonWebServiceClientCopyright © 2022. All rights reserved.