software.amazon.awssdk.services.mediatailor

Interface MediaTailorClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface MediaTailorClient
extends SdkClient

Service client for accessing MediaTailor. This can be created using the static builder() method.

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

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static MediaTailorClientBuilder	builder() Create a builder that can be used to configure and create a MediaTailorClient.
static MediaTailorClient	create() Create a MediaTailorClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeletePlaybackConfigurationResponse	deletePlaybackConfiguration(Consumer<DeletePlaybackConfigurationRequest.Builder> deletePlaybackConfigurationRequest) Deletes the configuration for the specified name.
default DeletePlaybackConfigurationResponse	deletePlaybackConfiguration(DeletePlaybackConfigurationRequest deletePlaybackConfigurationRequest) Deletes the configuration for the specified name.
default GetPlaybackConfigurationResponse	getPlaybackConfiguration(Consumer<GetPlaybackConfigurationRequest.Builder> getPlaybackConfigurationRequest) Returns the configuration for the specified name.
default GetPlaybackConfigurationResponse	getPlaybackConfiguration(GetPlaybackConfigurationRequest getPlaybackConfigurationRequest) Returns the configuration for the specified name.
default ListPlaybackConfigurationsResponse	listPlaybackConfigurations() Returns a list of the configurations defined in AWS Elemental MediaTailor.
default ListPlaybackConfigurationsResponse	listPlaybackConfigurations(Consumer<ListPlaybackConfigurationsRequest.Builder> listPlaybackConfigurationsRequest) Returns a list of the configurations defined in AWS Elemental MediaTailor.
default ListPlaybackConfigurationsResponse	listPlaybackConfigurations(ListPlaybackConfigurationsRequest listPlaybackConfigurationsRequest) Returns a list of the configurations defined in AWS Elemental MediaTailor.
default PutPlaybackConfigurationResponse	putPlaybackConfiguration(Consumer<PutPlaybackConfigurationRequest.Builder> putPlaybackConfigurationRequest) Adds a new configuration to AWS Elemental MediaTailor.
default PutPlaybackConfigurationResponse	putPlaybackConfiguration(PutPlaybackConfigurationRequest putPlaybackConfigurationRequest) Adds a new configuration to AWS Elemental MediaTailor.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static MediaTailorClient create()

Create a MediaTailorClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MediaTailorClientBuilder builder()

Create a builder that can be used to configure and create a MediaTailorClient.

deletePlaybackConfiguration

default DeletePlaybackConfigurationResponse deletePlaybackConfiguration(DeletePlaybackConfigurationRequest deletePlaybackConfigurationRequest)
                                                                 throws AwsServiceException,
                                                                        SdkClientException,
                                                                        MediaTailorException

Deletes the configuration for the specified name.

Parameters:

deletePlaybackConfigurationRequest -

Returns:

Result of the DeletePlaybackConfiguration operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MediaTailorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deletePlaybackConfiguration

default DeletePlaybackConfigurationResponse deletePlaybackConfiguration(Consumer<DeletePlaybackConfigurationRequest.Builder> deletePlaybackConfigurationRequest)
                                                                 throws AwsServiceException,
                                                                        SdkClientException,
                                                                        MediaTailorException

Deletes the configuration for the specified name.

This is a convenience which creates an instance of the DeletePlaybackConfigurationRequest.Builder avoiding the need to create one manually via DeletePlaybackConfigurationRequest.builder()

Parameters:

deletePlaybackConfigurationRequest - A Consumer that will call methods on DeletePlaybackConfigurationRequest.Builder to create a request.

Returns:

Result of the DeletePlaybackConfiguration operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MediaTailorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getPlaybackConfiguration

default GetPlaybackConfigurationResponse getPlaybackConfiguration(GetPlaybackConfigurationRequest getPlaybackConfigurationRequest)
                                                           throws AwsServiceException,
                                                                  SdkClientException,
                                                                  MediaTailorException

Returns the configuration for the specified name.

Parameters:

getPlaybackConfigurationRequest -

Returns:

Result of the GetPlaybackConfiguration operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MediaTailorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getPlaybackConfiguration

default GetPlaybackConfigurationResponse getPlaybackConfiguration(Consumer<GetPlaybackConfigurationRequest.Builder> getPlaybackConfigurationRequest)
                                                           throws AwsServiceException,
                                                                  SdkClientException,
                                                                  MediaTailorException

Returns the configuration for the specified name.

This is a convenience which creates an instance of the GetPlaybackConfigurationRequest.Builder avoiding the need to create one manually via GetPlaybackConfigurationRequest.builder()

Parameters:

getPlaybackConfigurationRequest - A Consumer that will call methods on GetPlaybackConfigurationRequest.Builder to create a request.

Returns:

Result of the GetPlaybackConfiguration operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MediaTailorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPlaybackConfigurations

default ListPlaybackConfigurationsResponse listPlaybackConfigurations()
                                                               throws AwsServiceException,
                                                                      SdkClientException,
                                                                      MediaTailorException

Returns a list of the configurations defined in AWS Elemental MediaTailor. You can specify a max number of configurations to return at a time. The default max is 50. Results are returned in pagefuls. If AWS Elemental MediaTailor has more configurations than the specified max, it provides parameters in the response that you can use to retrieve the next pageful.

Returns:

Result of the ListPlaybackConfigurations operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MediaTailorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

listPlaybackConfigurations(ListPlaybackConfigurationsRequest), AWS API Documentation

listPlaybackConfigurations

default ListPlaybackConfigurationsResponse listPlaybackConfigurations(ListPlaybackConfigurationsRequest listPlaybackConfigurationsRequest)
                                                               throws AwsServiceException,
                                                                      SdkClientException,
                                                                      MediaTailorException

Returns a list of the configurations defined in AWS Elemental MediaTailor. You can specify a max number of configurations to return at a time. The default max is 50. Results are returned in pagefuls. If AWS Elemental MediaTailor has more configurations than the specified max, it provides parameters in the response that you can use to retrieve the next pageful.

Parameters:

listPlaybackConfigurationsRequest -

Returns:

Result of the ListPlaybackConfigurations operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MediaTailorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listPlaybackConfigurations

default ListPlaybackConfigurationsResponse listPlaybackConfigurations(Consumer<ListPlaybackConfigurationsRequest.Builder> listPlaybackConfigurationsRequest)
                                                               throws AwsServiceException,
                                                                      SdkClientException,
                                                                      MediaTailorException

Returns a list of the configurations defined in AWS Elemental MediaTailor. You can specify a max number of configurations to return at a time. The default max is 50. Results are returned in pagefuls. If AWS Elemental MediaTailor has more configurations than the specified max, it provides parameters in the response that you can use to retrieve the next pageful.

This is a convenience which creates an instance of the ListPlaybackConfigurationsRequest.Builder avoiding the need to create one manually via ListPlaybackConfigurationsRequest.builder()

Parameters:

listPlaybackConfigurationsRequest - A Consumer that will call methods on ListPlaybackConfigurationsRequest.Builder to create a request.

Returns:

Result of the ListPlaybackConfigurations operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MediaTailorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putPlaybackConfiguration

default PutPlaybackConfigurationResponse putPlaybackConfiguration(PutPlaybackConfigurationRequest putPlaybackConfigurationRequest)
                                                           throws AwsServiceException,
                                                                  SdkClientException,
                                                                  MediaTailorException

Adds a new configuration to AWS Elemental MediaTailor.

Parameters:

putPlaybackConfigurationRequest -

Returns:

Result of the PutPlaybackConfiguration operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MediaTailorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putPlaybackConfiguration

default PutPlaybackConfigurationResponse putPlaybackConfiguration(Consumer<PutPlaybackConfigurationRequest.Builder> putPlaybackConfigurationRequest)
                                                           throws AwsServiceException,
                                                                  SdkClientException,
                                                                  MediaTailorException

Adds a new configuration to AWS Elemental MediaTailor.

This is a convenience which creates an instance of the PutPlaybackConfigurationRequest.Builder avoiding the need to create one manually via PutPlaybackConfigurationRequest.builder()

Parameters:

putPlaybackConfigurationRequest - A Consumer that will call methods on PutPlaybackConfigurationRequest.Builder to create a request.

Returns:

Result of the PutPlaybackConfiguration operation returned by the service.

Throws:

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MediaTailorException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()