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 SDK to configure scalable ad insertion for your live and VOD content. With AWS Elemental MediaTailor, you can 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 SDK, you manage AWS Elemental MediaTailor configurations 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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMediaTailorClientBuilder	builder()
DeletePlaybackConfigurationResult	deletePlaybackConfiguration(DeletePlaybackConfigurationRequest request) Deletes the playback configuration for the specified name.
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.
GetPlaybackConfigurationResult	getPlaybackConfiguration(GetPlaybackConfigurationRequest request) Returns the playback configuration for the specified name.
ListPlaybackConfigurationsResult	listPlaybackConfigurations(ListPlaybackConfigurationsRequest request) Returns a list of the playback configurations defined in AWS Elemental MediaTailor.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of the tags assigned to the specified playback configuration resource.
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.
TagResourceResult	tagResource(TagResourceRequest request) Adds tags to the specified playback configuration resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from the specified playback configuration resource.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AWSMediaTailorClientBuilder builder()

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

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

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

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

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

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

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 class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. 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