Interface MediaTailorAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface MediaTailorAsyncClient extends AwsClient
Service client for accessing MediaTailor asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • configureLogsForChannel

      default CompletableFuture<ConfigureLogsForChannelResponse> configureLogsForChannel(ConfigureLogsForChannelRequest configureLogsForChannelRequest)

      Configures Amazon CloudWatch log settings for a channel.

      Parameters:
      configureLogsForChannelRequest -
      Returns:
      A Java Future containing the result of the ConfigureLogsForChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • configureLogsForChannel

      default CompletableFuture<ConfigureLogsForChannelResponse> configureLogsForChannel(Consumer<ConfigureLogsForChannelRequest.Builder> configureLogsForChannelRequest)

      Configures Amazon CloudWatch log settings for a channel.


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

      Parameters:
      configureLogsForChannelRequest - A Consumer that will call methods on ConfigureLogsForChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ConfigureLogsForChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • configureLogsForPlaybackConfiguration

      default CompletableFuture<ConfigureLogsForPlaybackConfigurationResponse> configureLogsForPlaybackConfiguration(ConfigureLogsForPlaybackConfigurationRequest configureLogsForPlaybackConfigurationRequest)

      Amazon CloudWatch log settings for a playback configuration.

      Parameters:
      configureLogsForPlaybackConfigurationRequest - Configures Amazon CloudWatch log settings for a playback configuration.
      Returns:
      A Java Future containing the result of the ConfigureLogsForPlaybackConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • configureLogsForPlaybackConfiguration

      default CompletableFuture<ConfigureLogsForPlaybackConfigurationResponse> configureLogsForPlaybackConfiguration(Consumer<ConfigureLogsForPlaybackConfigurationRequest.Builder> configureLogsForPlaybackConfigurationRequest)

      Amazon CloudWatch log settings for a playback configuration.


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

      Parameters:
      configureLogsForPlaybackConfigurationRequest - A Consumer that will call methods on ConfigureLogsForPlaybackConfigurationRequest.Builder to create a request. Configures Amazon CloudWatch log settings for a playback configuration.
      Returns:
      A Java Future containing the result of the ConfigureLogsForPlaybackConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createChannel

      default CompletableFuture<CreateChannelResponse> createChannel(CreateChannelRequest createChannelRequest)

      Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

      Parameters:
      createChannelRequest -
      Returns:
      A Java Future containing the result of the CreateChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createChannel

      default CompletableFuture<CreateChannelResponse> createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)

      Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.


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

      Parameters:
      createChannelRequest - A Consumer that will call methods on CreateChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createLiveSource

      default CompletableFuture<CreateLiveSourceResponse> createLiveSource(CreateLiveSourceRequest createLiveSourceRequest)

      The live source configuration.

      Parameters:
      createLiveSourceRequest -
      Returns:
      A Java Future containing the result of the CreateLiveSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createLiveSource

      default CompletableFuture<CreateLiveSourceResponse> createLiveSource(Consumer<CreateLiveSourceRequest.Builder> createLiveSourceRequest)

      The live source configuration.


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

      Parameters:
      createLiveSourceRequest - A Consumer that will call methods on CreateLiveSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLiveSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createPrefetchSchedule

      default CompletableFuture<CreatePrefetchScheduleResponse> createPrefetchSchedule(CreatePrefetchScheduleRequest createPrefetchScheduleRequest)

      Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

      Parameters:
      createPrefetchScheduleRequest -
      Returns:
      A Java Future containing the result of the CreatePrefetchSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createPrefetchSchedule

      default CompletableFuture<CreatePrefetchScheduleResponse> createPrefetchSchedule(Consumer<CreatePrefetchScheduleRequest.Builder> createPrefetchScheduleRequest)

      Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.


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

      Parameters:
      createPrefetchScheduleRequest - A Consumer that will call methods on CreatePrefetchScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePrefetchSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createProgram

      default CompletableFuture<CreateProgramResponse> createProgram(CreateProgramRequest createProgramRequest)

      Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

      Parameters:
      createProgramRequest -
      Returns:
      A Java Future containing the result of the CreateProgram operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createProgram

      default CompletableFuture<CreateProgramResponse> createProgram(Consumer<CreateProgramRequest.Builder> createProgramRequest)

      Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.


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

      Parameters:
      createProgramRequest - A Consumer that will call methods on CreateProgramRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateProgram operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createSourceLocation

      default CompletableFuture<CreateSourceLocationResponse> createSourceLocation(CreateSourceLocationRequest createSourceLocationRequest)

      Creates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

      Parameters:
      createSourceLocationRequest -
      Returns:
      A Java Future containing the result of the CreateSourceLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createSourceLocation

      default CompletableFuture<CreateSourceLocationResponse> createSourceLocation(Consumer<CreateSourceLocationRequest.Builder> createSourceLocationRequest)

      Creates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.


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

      Parameters:
      createSourceLocationRequest - A Consumer that will call methods on CreateSourceLocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSourceLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createVodSource

      default CompletableFuture<CreateVodSourceResponse> createVodSource(CreateVodSourceRequest createVodSourceRequest)

      The VOD source configuration parameters.

      Parameters:
      createVodSourceRequest -
      Returns:
      A Java Future containing the result of the CreateVodSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • createVodSource

      default CompletableFuture<CreateVodSourceResponse> createVodSource(Consumer<CreateVodSourceRequest.Builder> createVodSourceRequest)

      The VOD source configuration parameters.


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

      Parameters:
      createVodSourceRequest - A Consumer that will call methods on CreateVodSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateVodSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteChannel

      default CompletableFuture<DeleteChannelResponse> deleteChannel(DeleteChannelRequest deleteChannelRequest)

      Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

      Parameters:
      deleteChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteChannel

      default CompletableFuture<DeleteChannelResponse> deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)

      Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.


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

      Parameters:
      deleteChannelRequest - A Consumer that will call methods on DeleteChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteChannelPolicy

      default CompletableFuture<DeleteChannelPolicyResponse> deleteChannelPolicy(DeleteChannelPolicyRequest deleteChannelPolicyRequest)

      The channel policy to delete.

      Parameters:
      deleteChannelPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteChannelPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteChannelPolicy

      default CompletableFuture<DeleteChannelPolicyResponse> deleteChannelPolicy(Consumer<DeleteChannelPolicyRequest.Builder> deleteChannelPolicyRequest)

      The channel policy to delete.


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

      Parameters:
      deleteChannelPolicyRequest - A Consumer that will call methods on DeleteChannelPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteChannelPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteLiveSource

      default CompletableFuture<DeleteLiveSourceResponse> deleteLiveSource(DeleteLiveSourceRequest deleteLiveSourceRequest)

      The live source to delete.

      Parameters:
      deleteLiveSourceRequest -
      Returns:
      A Java Future containing the result of the DeleteLiveSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteLiveSource

      default CompletableFuture<DeleteLiveSourceResponse> deleteLiveSource(Consumer<DeleteLiveSourceRequest.Builder> deleteLiveSourceRequest)

      The live source to delete.


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

      Parameters:
      deleteLiveSourceRequest - A Consumer that will call methods on DeleteLiveSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLiveSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deletePlaybackConfiguration

      default CompletableFuture<DeletePlaybackConfigurationResponse> deletePlaybackConfiguration(DeletePlaybackConfigurationRequest deletePlaybackConfigurationRequest)

      Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

      Parameters:
      deletePlaybackConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeletePlaybackConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deletePlaybackConfiguration

      default CompletableFuture<DeletePlaybackConfigurationResponse> deletePlaybackConfiguration(Consumer<DeletePlaybackConfigurationRequest.Builder> deletePlaybackConfigurationRequest)

      Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.


      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:
      A Java Future containing the result of the DeletePlaybackConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deletePrefetchSchedule

      default CompletableFuture<DeletePrefetchScheduleResponse> deletePrefetchSchedule(DeletePrefetchScheduleRequest deletePrefetchScheduleRequest)

      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. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

      Parameters:
      deletePrefetchScheduleRequest -
      Returns:
      A Java Future containing the result of the DeletePrefetchSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deletePrefetchSchedule

      default CompletableFuture<DeletePrefetchScheduleResponse> deletePrefetchSchedule(Consumer<DeletePrefetchScheduleRequest.Builder> deletePrefetchScheduleRequest)

      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. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.


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

      Parameters:
      deletePrefetchScheduleRequest - A Consumer that will call methods on DeletePrefetchScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePrefetchSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteProgram

      default CompletableFuture<DeleteProgramResponse> deleteProgram(DeleteProgramRequest deleteProgramRequest)

      Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

      Parameters:
      deleteProgramRequest -
      Returns:
      A Java Future containing the result of the DeleteProgram operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteProgram

      default CompletableFuture<DeleteProgramResponse> deleteProgram(Consumer<DeleteProgramRequest.Builder> deleteProgramRequest)

      Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.


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

      Parameters:
      deleteProgramRequest - A Consumer that will call methods on DeleteProgramRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteProgram operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteSourceLocation

      default CompletableFuture<DeleteSourceLocationResponse> deleteSourceLocation(DeleteSourceLocationRequest deleteSourceLocationRequest)

      Deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

      Parameters:
      deleteSourceLocationRequest -
      Returns:
      A Java Future containing the result of the DeleteSourceLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteSourceLocation

      default CompletableFuture<DeleteSourceLocationResponse> deleteSourceLocation(Consumer<DeleteSourceLocationRequest.Builder> deleteSourceLocationRequest)

      Deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.


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

      Parameters:
      deleteSourceLocationRequest - A Consumer that will call methods on DeleteSourceLocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSourceLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteVodSource

      default CompletableFuture<DeleteVodSourceResponse> deleteVodSource(DeleteVodSourceRequest deleteVodSourceRequest)

      The video on demand (VOD) source to delete.

      Parameters:
      deleteVodSourceRequest -
      Returns:
      A Java Future containing the result of the DeleteVodSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • deleteVodSource

      default CompletableFuture<DeleteVodSourceResponse> deleteVodSource(Consumer<DeleteVodSourceRequest.Builder> deleteVodSourceRequest)

      The video on demand (VOD) source to delete.


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

      Parameters:
      deleteVodSourceRequest - A Consumer that will call methods on DeleteVodSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteVodSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • describeChannel

      default CompletableFuture<DescribeChannelResponse> describeChannel(DescribeChannelRequest describeChannelRequest)

      Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

      Parameters:
      describeChannelRequest -
      Returns:
      A Java Future containing the result of the DescribeChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • describeChannel

      default CompletableFuture<DescribeChannelResponse> describeChannel(Consumer<DescribeChannelRequest.Builder> describeChannelRequest)

      Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.


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

      Parameters:
      describeChannelRequest - A Consumer that will call methods on DescribeChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • describeLiveSource

      default CompletableFuture<DescribeLiveSourceResponse> describeLiveSource(DescribeLiveSourceRequest describeLiveSourceRequest)

      The live source to describe.

      Parameters:
      describeLiveSourceRequest -
      Returns:
      A Java Future containing the result of the DescribeLiveSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • describeLiveSource

      default CompletableFuture<DescribeLiveSourceResponse> describeLiveSource(Consumer<DescribeLiveSourceRequest.Builder> describeLiveSourceRequest)

      The live source to describe.


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

      Parameters:
      describeLiveSourceRequest - A Consumer that will call methods on DescribeLiveSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLiveSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • describeProgram

      default CompletableFuture<DescribeProgramResponse> describeProgram(DescribeProgramRequest describeProgramRequest)

      Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.

      Parameters:
      describeProgramRequest -
      Returns:
      A Java Future containing the result of the DescribeProgram operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • describeProgram

      default CompletableFuture<DescribeProgramResponse> describeProgram(Consumer<DescribeProgramRequest.Builder> describeProgramRequest)

      Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.


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

      Parameters:
      describeProgramRequest - A Consumer that will call methods on DescribeProgramRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeProgram operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • describeSourceLocation

      default CompletableFuture<DescribeSourceLocationResponse> describeSourceLocation(DescribeSourceLocationRequest describeSourceLocationRequest)

      Describes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

      Parameters:
      describeSourceLocationRequest -
      Returns:
      A Java Future containing the result of the DescribeSourceLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • describeSourceLocation

      default CompletableFuture<DescribeSourceLocationResponse> describeSourceLocation(Consumer<DescribeSourceLocationRequest.Builder> describeSourceLocationRequest)

      Describes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.


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

      Parameters:
      describeSourceLocationRequest - A Consumer that will call methods on DescribeSourceLocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSourceLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • describeVodSource

      default CompletableFuture<DescribeVodSourceResponse> describeVodSource(DescribeVodSourceRequest describeVodSourceRequest)

      Provides details about a specific video on demand (VOD) source in a specific source location.

      Parameters:
      describeVodSourceRequest -
      Returns:
      A Java Future containing the result of the DescribeVodSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • describeVodSource

      default CompletableFuture<DescribeVodSourceResponse> describeVodSource(Consumer<DescribeVodSourceRequest.Builder> describeVodSourceRequest)

      Provides details about a specific video on demand (VOD) source in a specific source location.


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

      Parameters:
      describeVodSourceRequest - A Consumer that will call methods on DescribeVodSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeVodSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • getChannelPolicy

      default CompletableFuture<GetChannelPolicyResponse> getChannelPolicy(GetChannelPolicyRequest getChannelPolicyRequest)

      Returns the channel's IAM policy. IAM policies are used to control access to your channel.

      Parameters:
      getChannelPolicyRequest -
      Returns:
      A Java Future containing the result of the GetChannelPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • getChannelPolicy

      default CompletableFuture<GetChannelPolicyResponse> getChannelPolicy(Consumer<GetChannelPolicyRequest.Builder> getChannelPolicyRequest)

      Returns the channel's IAM policy. IAM policies are used to control access to your channel.


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

      Parameters:
      getChannelPolicyRequest - A Consumer that will call methods on GetChannelPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetChannelPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • getChannelSchedule

      default CompletableFuture<GetChannelScheduleResponse> getChannelSchedule(GetChannelScheduleRequest getChannelScheduleRequest)

      Retrieves information about your channel's schedule.

      Parameters:
      getChannelScheduleRequest -
      Returns:
      A Java Future containing the result of the GetChannelSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • getChannelSchedule

      default CompletableFuture<GetChannelScheduleResponse> getChannelSchedule(Consumer<GetChannelScheduleRequest.Builder> getChannelScheduleRequest)

      Retrieves information about your channel's schedule.


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

      Parameters:
      getChannelScheduleRequest - A Consumer that will call methods on GetChannelScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetChannelSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • getChannelSchedulePaginator

      default GetChannelSchedulePublisher getChannelSchedulePaginator(GetChannelScheduleRequest getChannelScheduleRequest)

      This is a variant of getChannelSchedule(software.amazon.awssdk.services.mediatailor.model.GetChannelScheduleRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.GetChannelSchedulePublisher publisher = client.getChannelSchedulePaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.GetChannelSchedulePublisher publisher = client.getChannelSchedulePaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.GetChannelScheduleResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.GetChannelScheduleResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getChannelSchedule(software.amazon.awssdk.services.mediatailor.model.GetChannelScheduleRequest) operation.

      Parameters:
      getChannelScheduleRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • getChannelSchedulePaginator

      default GetChannelSchedulePublisher getChannelSchedulePaginator(Consumer<GetChannelScheduleRequest.Builder> getChannelScheduleRequest)

      This is a variant of getChannelSchedule(software.amazon.awssdk.services.mediatailor.model.GetChannelScheduleRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.GetChannelSchedulePublisher publisher = client.getChannelSchedulePaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.GetChannelSchedulePublisher publisher = client.getChannelSchedulePaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.GetChannelScheduleResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.GetChannelScheduleResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getChannelSchedule(software.amazon.awssdk.services.mediatailor.model.GetChannelScheduleRequest) operation.


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

      Parameters:
      getChannelScheduleRequest - A Consumer that will call methods on GetChannelScheduleRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • getPlaybackConfiguration

      default CompletableFuture<GetPlaybackConfigurationResponse> getPlaybackConfiguration(GetPlaybackConfigurationRequest getPlaybackConfigurationRequest)

      Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

      Parameters:
      getPlaybackConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetPlaybackConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • getPlaybackConfiguration

      default CompletableFuture<GetPlaybackConfigurationResponse> getPlaybackConfiguration(Consumer<GetPlaybackConfigurationRequest.Builder> getPlaybackConfigurationRequest)

      Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.


      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:
      A Java Future containing the result of the GetPlaybackConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • getPrefetchSchedule

      default CompletableFuture<GetPrefetchScheduleResponse> getPrefetchSchedule(GetPrefetchScheduleRequest getPrefetchScheduleRequest)

      Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

      Parameters:
      getPrefetchScheduleRequest -
      Returns:
      A Java Future containing the result of the GetPrefetchSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • getPrefetchSchedule

      default CompletableFuture<GetPrefetchScheduleResponse> getPrefetchSchedule(Consumer<GetPrefetchScheduleRequest.Builder> getPrefetchScheduleRequest)

      Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.


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

      Parameters:
      getPrefetchScheduleRequest - A Consumer that will call methods on GetPrefetchScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPrefetchSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listAlerts

      default CompletableFuture<ListAlertsResponse> listAlerts(ListAlertsRequest listAlertsRequest)

      Lists the alerts that are associated with a MediaTailor channel assembly resource.

      Parameters:
      listAlertsRequest -
      Returns:
      A Java Future containing the result of the ListAlerts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listAlerts

      default CompletableFuture<ListAlertsResponse> listAlerts(Consumer<ListAlertsRequest.Builder> listAlertsRequest)

      Lists the alerts that are associated with a MediaTailor channel assembly resource.


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

      Parameters:
      listAlertsRequest - A Consumer that will call methods on ListAlertsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAlerts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listAlertsPaginator

      default ListAlertsPublisher listAlertsPaginator(ListAlertsRequest listAlertsRequest)

      This is a variant of listAlerts(software.amazon.awssdk.services.mediatailor.model.ListAlertsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListAlertsPublisher publisher = client.listAlertsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListAlertsPublisher publisher = client.listAlertsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListAlertsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListAlertsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAlerts(software.amazon.awssdk.services.mediatailor.model.ListAlertsRequest) operation.

      Parameters:
      listAlertsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listAlertsPaginator

      default ListAlertsPublisher listAlertsPaginator(Consumer<ListAlertsRequest.Builder> listAlertsRequest)

      This is a variant of listAlerts(software.amazon.awssdk.services.mediatailor.model.ListAlertsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListAlertsPublisher publisher = client.listAlertsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListAlertsPublisher publisher = client.listAlertsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListAlertsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListAlertsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAlerts(software.amazon.awssdk.services.mediatailor.model.ListAlertsRequest) operation.


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

      Parameters:
      listAlertsRequest - A Consumer that will call methods on ListAlertsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listChannels

      default CompletableFuture<ListChannelsResponse> listChannels(ListChannelsRequest listChannelsRequest)

      Retrieves information about the channels that are associated with the current AWS account.

      Parameters:
      listChannelsRequest -
      Returns:
      A Java Future containing the result of the ListChannels operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listChannels

      default CompletableFuture<ListChannelsResponse> listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)

      Retrieves information about the channels that are associated with the current AWS account.


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

      Parameters:
      listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListChannels operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listChannelsPaginator

      default ListChannelsPublisher listChannelsPaginator(ListChannelsRequest listChannelsRequest)

      This is a variant of listChannels(software.amazon.awssdk.services.mediatailor.model.ListChannelsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListChannelsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListChannelsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listChannels(software.amazon.awssdk.services.mediatailor.model.ListChannelsRequest) operation.

      Parameters:
      listChannelsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listChannelsPaginator

      default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)

      This is a variant of listChannels(software.amazon.awssdk.services.mediatailor.model.ListChannelsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListChannelsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListChannelsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listChannels(software.amazon.awssdk.services.mediatailor.model.ListChannelsRequest) operation.


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

      Parameters:
      listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listLiveSources

      default CompletableFuture<ListLiveSourcesResponse> listLiveSources(ListLiveSourcesRequest listLiveSourcesRequest)

      Lists the live sources contained in a source location. A source represents a piece of content.

      Parameters:
      listLiveSourcesRequest -
      Returns:
      A Java Future containing the result of the ListLiveSources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listLiveSources

      default CompletableFuture<ListLiveSourcesResponse> listLiveSources(Consumer<ListLiveSourcesRequest.Builder> listLiveSourcesRequest)

      Lists the live sources contained in a source location. A source represents a piece of content.


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

      Parameters:
      listLiveSourcesRequest - A Consumer that will call methods on ListLiveSourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLiveSources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listLiveSourcesPaginator

      default ListLiveSourcesPublisher listLiveSourcesPaginator(ListLiveSourcesRequest listLiveSourcesRequest)

      This is a variant of listLiveSources(software.amazon.awssdk.services.mediatailor.model.ListLiveSourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListLiveSourcesPublisher publisher = client.listLiveSourcesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListLiveSourcesPublisher publisher = client.listLiveSourcesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListLiveSourcesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListLiveSourcesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLiveSources(software.amazon.awssdk.services.mediatailor.model.ListLiveSourcesRequest) operation.

      Parameters:
      listLiveSourcesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listLiveSourcesPaginator

      default ListLiveSourcesPublisher listLiveSourcesPaginator(Consumer<ListLiveSourcesRequest.Builder> listLiveSourcesRequest)

      This is a variant of listLiveSources(software.amazon.awssdk.services.mediatailor.model.ListLiveSourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListLiveSourcesPublisher publisher = client.listLiveSourcesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListLiveSourcesPublisher publisher = client.listLiveSourcesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListLiveSourcesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListLiveSourcesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLiveSources(software.amazon.awssdk.services.mediatailor.model.ListLiveSourcesRequest) operation.


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

      Parameters:
      listLiveSourcesRequest - A Consumer that will call methods on ListLiveSourcesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listPlaybackConfigurations

      default CompletableFuture<ListPlaybackConfigurationsResponse> listPlaybackConfigurations(ListPlaybackConfigurationsRequest listPlaybackConfigurationsRequest)

      Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.

      Parameters:
      listPlaybackConfigurationsRequest -
      Returns:
      A Java Future containing the result of the ListPlaybackConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listPlaybackConfigurations

      default CompletableFuture<ListPlaybackConfigurationsResponse> listPlaybackConfigurations(Consumer<ListPlaybackConfigurationsRequest.Builder> listPlaybackConfigurationsRequest)

      Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.


      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:
      A Java Future containing the result of the ListPlaybackConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listPlaybackConfigurations

      default CompletableFuture<ListPlaybackConfigurationsResponse> listPlaybackConfigurations()

      Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.

      Returns:
      A Java Future containing the result of the ListPlaybackConfigurations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listPlaybackConfigurationsPaginator

      default ListPlaybackConfigurationsPublisher listPlaybackConfigurationsPaginator()

      This is a variant of listPlaybackConfigurations(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListPlaybackConfigurationsPublisher publisher = client.listPlaybackConfigurationsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListPlaybackConfigurationsPublisher publisher = client.listPlaybackConfigurationsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlaybackConfigurations(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listPlaybackConfigurationsPaginator

      default ListPlaybackConfigurationsPublisher listPlaybackConfigurationsPaginator(ListPlaybackConfigurationsRequest listPlaybackConfigurationsRequest)

      This is a variant of listPlaybackConfigurations(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListPlaybackConfigurationsPublisher publisher = client.listPlaybackConfigurationsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListPlaybackConfigurationsPublisher publisher = client.listPlaybackConfigurationsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlaybackConfigurations(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsRequest) operation.

      Parameters:
      listPlaybackConfigurationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listPlaybackConfigurationsPaginator

      default ListPlaybackConfigurationsPublisher listPlaybackConfigurationsPaginator(Consumer<ListPlaybackConfigurationsRequest.Builder> listPlaybackConfigurationsRequest)

      This is a variant of listPlaybackConfigurations(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListPlaybackConfigurationsPublisher publisher = client.listPlaybackConfigurationsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListPlaybackConfigurationsPublisher publisher = client.listPlaybackConfigurationsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlaybackConfigurations(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsRequest) operation.


      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:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listPrefetchSchedules

      default CompletableFuture<ListPrefetchSchedulesResponse> listPrefetchSchedules(ListPrefetchSchedulesRequest listPrefetchSchedulesRequest)

      Lists the prefetch schedules for a playback configuration.

      Parameters:
      listPrefetchSchedulesRequest -
      Returns:
      A Java Future containing the result of the ListPrefetchSchedules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listPrefetchSchedules

      default CompletableFuture<ListPrefetchSchedulesResponse> listPrefetchSchedules(Consumer<ListPrefetchSchedulesRequest.Builder> listPrefetchSchedulesRequest)

      Lists the prefetch schedules for a playback configuration.


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

      Parameters:
      listPrefetchSchedulesRequest - A Consumer that will call methods on ListPrefetchSchedulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPrefetchSchedules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listPrefetchSchedulesPaginator

      default ListPrefetchSchedulesPublisher listPrefetchSchedulesPaginator(ListPrefetchSchedulesRequest listPrefetchSchedulesRequest)

      This is a variant of listPrefetchSchedules(software.amazon.awssdk.services.mediatailor.model.ListPrefetchSchedulesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListPrefetchSchedulesPublisher publisher = client.listPrefetchSchedulesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListPrefetchSchedulesPublisher publisher = client.listPrefetchSchedulesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListPrefetchSchedulesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListPrefetchSchedulesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPrefetchSchedules(software.amazon.awssdk.services.mediatailor.model.ListPrefetchSchedulesRequest) operation.

      Parameters:
      listPrefetchSchedulesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listPrefetchSchedulesPaginator

      default ListPrefetchSchedulesPublisher listPrefetchSchedulesPaginator(Consumer<ListPrefetchSchedulesRequest.Builder> listPrefetchSchedulesRequest)

      This is a variant of listPrefetchSchedules(software.amazon.awssdk.services.mediatailor.model.ListPrefetchSchedulesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListPrefetchSchedulesPublisher publisher = client.listPrefetchSchedulesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListPrefetchSchedulesPublisher publisher = client.listPrefetchSchedulesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListPrefetchSchedulesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListPrefetchSchedulesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPrefetchSchedules(software.amazon.awssdk.services.mediatailor.model.ListPrefetchSchedulesRequest) operation.


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

      Parameters:
      listPrefetchSchedulesRequest - A Consumer that will call methods on ListPrefetchSchedulesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listSourceLocations

      default CompletableFuture<ListSourceLocationsResponse> listSourceLocations(ListSourceLocationsRequest listSourceLocationsRequest)

      Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.

      Parameters:
      listSourceLocationsRequest -
      Returns:
      A Java Future containing the result of the ListSourceLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listSourceLocations

      default CompletableFuture<ListSourceLocationsResponse> listSourceLocations(Consumer<ListSourceLocationsRequest.Builder> listSourceLocationsRequest)

      Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.


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

      Parameters:
      listSourceLocationsRequest - A Consumer that will call methods on ListSourceLocationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSourceLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listSourceLocationsPaginator

      default ListSourceLocationsPublisher listSourceLocationsPaginator(ListSourceLocationsRequest listSourceLocationsRequest)

      This is a variant of listSourceLocations(software.amazon.awssdk.services.mediatailor.model.ListSourceLocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListSourceLocationsPublisher publisher = client.listSourceLocationsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListSourceLocationsPublisher publisher = client.listSourceLocationsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListSourceLocationsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListSourceLocationsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSourceLocations(software.amazon.awssdk.services.mediatailor.model.ListSourceLocationsRequest) operation.

      Parameters:
      listSourceLocationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listSourceLocationsPaginator

      default ListSourceLocationsPublisher listSourceLocationsPaginator(Consumer<ListSourceLocationsRequest.Builder> listSourceLocationsRequest)

      This is a variant of listSourceLocations(software.amazon.awssdk.services.mediatailor.model.ListSourceLocationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListSourceLocationsPublisher publisher = client.listSourceLocationsPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListSourceLocationsPublisher publisher = client.listSourceLocationsPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListSourceLocationsResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListSourceLocationsResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSourceLocations(software.amazon.awssdk.services.mediatailor.model.ListSourceLocationsRequest) operation.


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

      Parameters:
      listSourceLocationsRequest - A Consumer that will call methods on ListSourceLocationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A request contains unexpected data.
      • 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.
      See Also:
    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A request contains unexpected data.
      • 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.
      See Also:
    • listVodSources

      default CompletableFuture<ListVodSourcesResponse> listVodSources(ListVodSourcesRequest listVodSourcesRequest)

      Lists the VOD sources contained in a source location. A source represents a piece of content.

      Parameters:
      listVodSourcesRequest -
      Returns:
      A Java Future containing the result of the ListVodSources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listVodSources

      default CompletableFuture<ListVodSourcesResponse> listVodSources(Consumer<ListVodSourcesRequest.Builder> listVodSourcesRequest)

      Lists the VOD sources contained in a source location. A source represents a piece of content.


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

      Parameters:
      listVodSourcesRequest - A Consumer that will call methods on ListVodSourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListVodSources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listVodSourcesPaginator

      default ListVodSourcesPublisher listVodSourcesPaginator(ListVodSourcesRequest listVodSourcesRequest)

      This is a variant of listVodSources(software.amazon.awssdk.services.mediatailor.model.ListVodSourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListVodSourcesPublisher publisher = client.listVodSourcesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListVodSourcesPublisher publisher = client.listVodSourcesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListVodSourcesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListVodSourcesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listVodSources(software.amazon.awssdk.services.mediatailor.model.ListVodSourcesRequest) operation.

      Parameters:
      listVodSourcesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • listVodSourcesPaginator

      default ListVodSourcesPublisher listVodSourcesPaginator(Consumer<ListVodSourcesRequest.Builder> listVodSourcesRequest)

      This is a variant of listVodSources(software.amazon.awssdk.services.mediatailor.model.ListVodSourcesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.mediatailor.paginators.ListVodSourcesPublisher publisher = client.listVodSourcesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.mediatailor.paginators.ListVodSourcesPublisher publisher = client.listVodSourcesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mediatailor.model.ListVodSourcesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.mediatailor.model.ListVodSourcesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listVodSources(software.amazon.awssdk.services.mediatailor.model.ListVodSourcesRequest) operation.


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

      Parameters:
      listVodSourcesRequest - A Consumer that will call methods on ListVodSourcesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • putChannelPolicy

      default CompletableFuture<PutChannelPolicyResponse> putChannelPolicy(PutChannelPolicyRequest putChannelPolicyRequest)

      Creates an IAM policy for the channel. IAM policies are used to control access to your channel.

      Parameters:
      putChannelPolicyRequest -
      Returns:
      A Java Future containing the result of the PutChannelPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • putChannelPolicy

      default CompletableFuture<PutChannelPolicyResponse> putChannelPolicy(Consumer<PutChannelPolicyRequest.Builder> putChannelPolicyRequest)

      Creates an IAM policy for the channel. IAM policies are used to control access to your channel.


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

      Parameters:
      putChannelPolicyRequest - A Consumer that will call methods on PutChannelPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutChannelPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • putPlaybackConfiguration

      default CompletableFuture<PutPlaybackConfigurationResponse> putPlaybackConfiguration(PutPlaybackConfigurationRequest putPlaybackConfigurationRequest)

      Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

      Parameters:
      putPlaybackConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutPlaybackConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • putPlaybackConfiguration

      default CompletableFuture<PutPlaybackConfigurationResponse> putPlaybackConfiguration(Consumer<PutPlaybackConfigurationRequest.Builder> putPlaybackConfigurationRequest)

      Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in 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:
      A Java Future containing the result of the PutPlaybackConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • startChannel

      default CompletableFuture<StartChannelResponse> startChannel(StartChannelRequest startChannelRequest)

      Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

      Parameters:
      startChannelRequest -
      Returns:
      A Java Future containing the result of the StartChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • startChannel

      default CompletableFuture<StartChannelResponse> startChannel(Consumer<StartChannelRequest.Builder> startChannelRequest)

      Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.


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

      Parameters:
      startChannelRequest - A Consumer that will call methods on StartChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • stopChannel

      default CompletableFuture<StopChannelResponse> stopChannel(StopChannelRequest stopChannelRequest)

      Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

      Parameters:
      stopChannelRequest -
      Returns:
      A Java Future containing the result of the StopChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • stopChannel

      default CompletableFuture<StopChannelResponse> stopChannel(Consumer<StopChannelRequest.Builder> stopChannelRequest)

      Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.


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

      Parameters:
      stopChannelRequest - A Consumer that will call methods on StopChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A request contains unexpected data.
      • 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.
      See Also:
    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A request contains unexpected data.
      • 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.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      The resource to untag.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A request contains unexpected data.
      • 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.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      The resource to untag.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A request contains unexpected data.
      • 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.
      See Also:
    • updateChannel

      default CompletableFuture<UpdateChannelResponse> updateChannel(UpdateChannelRequest updateChannelRequest)

      Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

      Parameters:
      updateChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • updateChannel

      default CompletableFuture<UpdateChannelResponse> updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)

      Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.


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

      Parameters:
      updateChannelRequest - A Consumer that will call methods on UpdateChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • updateLiveSource

      default CompletableFuture<UpdateLiveSourceResponse> updateLiveSource(UpdateLiveSourceRequest updateLiveSourceRequest)

      Updates a live source's configuration.

      Parameters:
      updateLiveSourceRequest -
      Returns:
      A Java Future containing the result of the UpdateLiveSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • updateLiveSource

      default CompletableFuture<UpdateLiveSourceResponse> updateLiveSource(Consumer<UpdateLiveSourceRequest.Builder> updateLiveSourceRequest)

      Updates a live source's configuration.


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

      Parameters:
      updateLiveSourceRequest - A Consumer that will call methods on UpdateLiveSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLiveSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • updateProgram

      default CompletableFuture<UpdateProgramResponse> updateProgram(UpdateProgramRequest updateProgramRequest)

      Updates a program within a channel.

      Parameters:
      updateProgramRequest -
      Returns:
      A Java Future containing the result of the UpdateProgram operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • updateProgram

      default CompletableFuture<UpdateProgramResponse> updateProgram(Consumer<UpdateProgramRequest.Builder> updateProgramRequest)

      Updates a program within a channel.


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

      Parameters:
      updateProgramRequest - A Consumer that will call methods on UpdateProgramRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateProgram operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • updateSourceLocation

      default CompletableFuture<UpdateSourceLocationResponse> updateSourceLocation(UpdateSourceLocationRequest updateSourceLocationRequest)

      Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

      Parameters:
      updateSourceLocationRequest -
      Returns:
      A Java Future containing the result of the UpdateSourceLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • updateSourceLocation

      default CompletableFuture<UpdateSourceLocationResponse> updateSourceLocation(Consumer<UpdateSourceLocationRequest.Builder> updateSourceLocationRequest)

      Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.


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

      Parameters:
      updateSourceLocationRequest - A Consumer that will call methods on UpdateSourceLocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSourceLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • updateVodSource

      default CompletableFuture<UpdateVodSourceResponse> updateVodSource(UpdateVodSourceRequest updateVodSourceRequest)

      Updates a VOD source's configuration.

      Parameters:
      updateVodSourceRequest -
      Returns:
      A Java Future containing the result of the UpdateVodSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • updateVodSource

      default CompletableFuture<UpdateVodSourceResponse> updateVodSource(Consumer<UpdateVodSourceRequest.Builder> updateVodSourceRequest)

      Updates a VOD source's configuration.


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

      Parameters:
      updateVodSourceRequest - A Consumer that will call methods on UpdateVodSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateVodSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:
    • serviceClientConfiguration

      default MediaTailorServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration
    • create

      static MediaTailorAsyncClient create()
      Create a MediaTailorAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
    • builder

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