com.amazonaws.services.mediatailor

Class AWSMediaTailorClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mediatailor.AWSMediaTailorClient

All Implemented Interfaces:

AWSMediaTailor

Direct Known Subclasses:

AWSMediaTailorAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSMediaTailorClient
extends AmazonWebServiceClient
implements AWSMediaTailor

Client for accessing MediaTailor. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.mediatailor.AWSMediaTailor

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMediaTailorClientBuilder	builder()
CreateChannelResult	createChannel(CreateChannelRequest request) Creates a channel.
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.
DeletePlaybackConfigurationResult	deletePlaybackConfiguration(DeletePlaybackConfigurationRequest request) Deletes the playback configuration for the specified name.
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.
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.
ListChannelsResult	listChannels(ListChannelsRequest request) Retrieves a list of channels that are associated with this account.
ListPlaybackConfigurationsResult	listPlaybackConfigurations(ListPlaybackConfigurationsRequest request) Returns a list of the playback configurations defined in AWS Elemental MediaTailor.
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.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSMediaTailorClientBuilder builder()

createChannel

public CreateChannelResult createChannel(CreateChannelRequest request)

Creates a channel.

Specified by:

createChannel in interface AWSMediaTailor

Parameters:

createChannelRequest -

Returns:

Result of the CreateChannel operation returned by the service.

See Also:

AWS API Documentation

createProgram

public CreateProgramResult createProgram(CreateProgramRequest request)

Creates a program.

Specified by:

createProgram in interface AWSMediaTailor

Parameters:

createProgramRequest -

Returns:

Result of the CreateProgram operation returned by the service.

See Also:

AWS API Documentation

createSourceLocation

public CreateSourceLocationResult createSourceLocation(CreateSourceLocationRequest request)

Creates a source location on a specific channel.

Specified by:

createSourceLocation in interface AWSMediaTailor

Parameters:

createSourceLocationRequest -

Returns:

Result of the CreateSourceLocation operation returned by the service.

See Also:

AWS API Documentation

createVodSource

public CreateVodSourceResult createVodSource(CreateVodSourceRequest request)

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

Specified by:

createVodSource in interface AWSMediaTailor

Parameters:

createVodSourceRequest -

Returns:

Result of the CreateVodSource operation returned by the service.

See Also:

AWS API Documentation

deleteChannel

public DeleteChannelResult deleteChannel(DeleteChannelRequest request)

Deletes a channel. You must stop the channel before it can be deleted.

Specified by:

deleteChannel in interface AWSMediaTailor

Parameters:

deleteChannelRequest -

Returns:

Result of the DeleteChannel operation returned by the service.

See Also:

AWS API Documentation

deleteChannelPolicy

public DeleteChannelPolicyResult deleteChannelPolicy(DeleteChannelPolicyRequest request)

Deletes a channel's IAM policy.

Specified by:

deleteChannelPolicy in interface AWSMediaTailor

Parameters:

deleteChannelPolicyRequest -

Returns:

Result of the DeleteChannelPolicy operation returned by the service.

See Also:

AWS API Documentation

deletePlaybackConfiguration

public DeletePlaybackConfigurationResult deletePlaybackConfiguration(DeletePlaybackConfigurationRequest request)

Deletes the playback configuration for the specified name.

Specified by:

deletePlaybackConfiguration in interface AWSMediaTailor

Parameters:

deletePlaybackConfigurationRequest -

Returns:

Result of the DeletePlaybackConfiguration operation returned by the service.

See Also:

AWS API Documentation

deleteProgram

public DeleteProgramResult deleteProgram(DeleteProgramRequest request)

Deletes a specific program on a specific channel.

Specified by:

deleteProgram in interface AWSMediaTailor

Parameters:

deleteProgramRequest -

Returns:

Result of the DeleteProgram operation returned by the service.

See Also:

AWS API Documentation

deleteSourceLocation

public DeleteSourceLocationResult deleteSourceLocation(DeleteSourceLocationRequest request)

Deletes a source location on a specific channel.

Specified by:

deleteSourceLocation in interface AWSMediaTailor

Parameters:

deleteSourceLocationRequest -

Returns:

Result of the DeleteSourceLocation operation returned by the service.

See Also:

AWS API Documentation

deleteVodSource

public DeleteVodSourceResult deleteVodSource(DeleteVodSourceRequest request)

Deletes a specific VOD source in a specific source location.

Specified by:

deleteVodSource in interface AWSMediaTailor

Parameters:

deleteVodSourceRequest -

Returns:

Result of the DeleteVodSource operation returned by the service.

See Also:

AWS API Documentation

describeChannel

public DescribeChannelResult describeChannel(DescribeChannelRequest request)

Describes the properties of a specific channel.

Specified by:

describeChannel in interface AWSMediaTailor

Parameters:

describeChannelRequest -

Returns:

Result of the DescribeChannel operation returned by the service.

See Also:

AWS API Documentation

describeProgram

public DescribeProgramResult describeProgram(DescribeProgramRequest request)

Retrieves the properties of the requested program.

Specified by:

describeProgram in interface AWSMediaTailor

Parameters:

describeProgramRequest -

Returns:

Result of the DescribeProgram operation returned by the service.

See Also:

AWS API Documentation

describeSourceLocation

public DescribeSourceLocationResult describeSourceLocation(DescribeSourceLocationRequest request)

Retrieves the properties of the requested source location.

Specified by:

describeSourceLocation in interface AWSMediaTailor

Parameters:

describeSourceLocationRequest -

Returns:

Result of the DescribeSourceLocation operation returned by the service.

See Also:

AWS API Documentation

describeVodSource

public DescribeVodSourceResult describeVodSource(DescribeVodSourceRequest request)

Provides details about a specific VOD source in a specific source location.

Specified by:

describeVodSource in interface AWSMediaTailor

Parameters:

describeVodSourceRequest -

Returns:

Result of the DescribeVodSource operation returned by the service.

See Also:

AWS API Documentation

getChannelPolicy

public GetChannelPolicyResult getChannelPolicy(GetChannelPolicyRequest request)

Retrieves information about a channel's IAM policy.

Specified by:

getChannelPolicy in interface AWSMediaTailor

Parameters:

getChannelPolicyRequest -

Returns:

Result of the GetChannelPolicy operation returned by the service.

See Also:

AWS API Documentation

getChannelSchedule

public GetChannelScheduleResult getChannelSchedule(GetChannelScheduleRequest request)

Retrieves information about your channel's schedule.

Specified by:

getChannelSchedule in interface AWSMediaTailor

Parameters:

getChannelScheduleRequest -

Returns:

Result of the GetChannelSchedule operation returned by the service.

See Also:

AWS API Documentation

getPlaybackConfiguration

public GetPlaybackConfigurationResult getPlaybackConfiguration(GetPlaybackConfigurationRequest request)

Returns the playback configuration for the specified name.

Specified by:

getPlaybackConfiguration in interface AWSMediaTailor

Parameters:

getPlaybackConfigurationRequest -

Returns:

Result of the GetPlaybackConfiguration operation returned by the service.

See Also:

AWS API Documentation

listChannels

public ListChannelsResult listChannels(ListChannelsRequest request)

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

Specified by:

listChannels in interface AWSMediaTailor

Parameters:

listChannelsRequest -

Returns:

Result of the ListChannels operation returned by the service.

See Also:

AWS API Documentation

listPlaybackConfigurations

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.

Specified by:

listPlaybackConfigurations in interface AWSMediaTailor

Parameters:

listPlaybackConfigurationsRequest -

Returns:

Result of the ListPlaybackConfigurations operation returned by the service.

See Also:

AWS API Documentation

listSourceLocations

public ListSourceLocationsResult listSourceLocations(ListSourceLocationsRequest request)

Retrieves a list of source locations.

Specified by:

listSourceLocations in interface AWSMediaTailor

Parameters:

listSourceLocationsRequest -

Returns:

Result of the ListSourceLocations operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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

Specified by:

listTagsForResource in interface AWSMediaTailor

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

BadRequestException - Invalid request parameters.

See Also:

AWS API Documentation

listVodSources

public ListVodSourcesResult listVodSources(ListVodSourcesRequest request)

Lists all the VOD sources in a source location.

Specified by:

listVodSources in interface AWSMediaTailor

Parameters:

listVodSourcesRequest -

Returns:

Result of the ListVodSources operation returned by the service.

See Also:

AWS API Documentation

putChannelPolicy

public PutChannelPolicyResult putChannelPolicy(PutChannelPolicyRequest request)

Creates an IAM policy for the channel.

Specified by:

putChannelPolicy in interface AWSMediaTailor

Parameters:

putChannelPolicyRequest -

Returns:

Result of the PutChannelPolicy operation returned by the service.

See Also:

AWS API Documentation

putPlaybackConfiguration

public PutPlaybackConfigurationResult putPlaybackConfiguration(PutPlaybackConfigurationRequest request)

Adds a new playback configuration to AWS Elemental MediaTailor.

Specified by:

putPlaybackConfiguration in interface AWSMediaTailor

Parameters:

putPlaybackConfigurationRequest -

Returns:

Result of the PutPlaybackConfiguration operation returned by the service.

See Also:

AWS API Documentation

startChannel

public StartChannelResult startChannel(StartChannelRequest request)

Starts a specific channel.

Specified by:

startChannel in interface AWSMediaTailor

Parameters:

startChannelRequest -

Returns:

Result of the StartChannel operation returned by the service.

See Also:

AWS API Documentation

stopChannel

public StopChannelResult stopChannel(StopChannelRequest request)

Stops a specific channel.

Specified by:

stopChannel in interface AWSMediaTailor

Parameters:

stopChannelRequest -

Returns:

Result of the StopChannel operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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

Specified by:

tagResource in interface AWSMediaTailor

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - Invalid request parameters.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

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

Specified by:

untagResource in interface AWSMediaTailor

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

BadRequestException - Invalid request parameters.

See Also:

AWS API Documentation

updateChannel

public UpdateChannelResult updateChannel(UpdateChannelRequest request)

Updates an existing channel.

Specified by:

updateChannel in interface AWSMediaTailor

Parameters:

updateChannelRequest -

Returns:

Result of the UpdateChannel operation returned by the service.

See Also:

AWS API Documentation

updateSourceLocation

public UpdateSourceLocationResult updateSourceLocation(UpdateSourceLocationRequest request)

Updates a source location on a specific channel.

Specified by:

updateSourceLocation in interface AWSMediaTailor

Parameters:

updateSourceLocationRequest -

Returns:

Result of the UpdateSourceLocation operation returned by the service.

See Also:

AWS API Documentation

updateVodSource

public UpdateVodSourceResult updateVodSource(UpdateVodSourceRequest request)

Updates a specific VOD source in a specific source location.

Specified by:

updateVodSource in interface AWSMediaTailor

Parameters:

updateVodSourceRequest -

Returns:

Result of the UpdateVodSource operation returned by the service.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSMediaTailor

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AWSMediaTailor

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.

Specified by:

shutdown in interface AWSMediaTailor

Overrides:

shutdown in class AmazonWebServiceClient