Interface MediaTailorAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.
Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aMediaTailorAsyncClient
.configureLogsForChannel
(Consumer<ConfigureLogsForChannelRequest.Builder> configureLogsForChannelRequest) Configures Amazon CloudWatch log settings for a channel.configureLogsForChannel
(ConfigureLogsForChannelRequest configureLogsForChannelRequest) Configures Amazon CloudWatch log settings for a channel.configureLogsForPlaybackConfiguration
(Consumer<ConfigureLogsForPlaybackConfigurationRequest.Builder> configureLogsForPlaybackConfigurationRequest) Amazon CloudWatch log settings for a playback configuration.configureLogsForPlaybackConfiguration
(ConfigureLogsForPlaybackConfigurationRequest configureLogsForPlaybackConfigurationRequest) Amazon CloudWatch log settings for a playback configuration.static MediaTailorAsyncClient
create()
Create aMediaTailorAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateChannelResponse> createChannel
(Consumer<CreateChannelRequest.Builder> createChannelRequest) Creates a channel.default CompletableFuture
<CreateChannelResponse> createChannel
(CreateChannelRequest createChannelRequest) Creates a channel.createLiveSource
(Consumer<CreateLiveSourceRequest.Builder> createLiveSourceRequest) The live source configuration.createLiveSource
(CreateLiveSourceRequest createLiveSourceRequest) The live source configuration.createPrefetchSchedule
(Consumer<CreatePrefetchScheduleRequest.Builder> createPrefetchScheduleRequest) Creates a prefetch schedule for a playback configuration.createPrefetchSchedule
(CreatePrefetchScheduleRequest createPrefetchScheduleRequest) Creates a prefetch schedule for a playback configuration.default CompletableFuture
<CreateProgramResponse> createProgram
(Consumer<CreateProgramRequest.Builder> createProgramRequest) Creates a program within a channel.default CompletableFuture
<CreateProgramResponse> createProgram
(CreateProgramRequest createProgramRequest) Creates a program within a channel.createSourceLocation
(Consumer<CreateSourceLocationRequest.Builder> createSourceLocationRequest) Creates a source location.createSourceLocation
(CreateSourceLocationRequest createSourceLocationRequest) Creates a source location.default CompletableFuture
<CreateVodSourceResponse> createVodSource
(Consumer<CreateVodSourceRequest.Builder> createVodSourceRequest) The VOD source configuration parameters.default CompletableFuture
<CreateVodSourceResponse> createVodSource
(CreateVodSourceRequest createVodSourceRequest) The VOD source configuration parameters.default CompletableFuture
<DeleteChannelResponse> deleteChannel
(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) Deletes a channel.default CompletableFuture
<DeleteChannelResponse> deleteChannel
(DeleteChannelRequest deleteChannelRequest) Deletes a channel.deleteChannelPolicy
(Consumer<DeleteChannelPolicyRequest.Builder> deleteChannelPolicyRequest) The channel policy to delete.deleteChannelPolicy
(DeleteChannelPolicyRequest deleteChannelPolicyRequest) The channel policy to delete.deleteLiveSource
(Consumer<DeleteLiveSourceRequest.Builder> deleteLiveSourceRequest) The live source to delete.deleteLiveSource
(DeleteLiveSourceRequest deleteLiveSourceRequest) The live source to delete.deletePlaybackConfiguration
(Consumer<DeletePlaybackConfigurationRequest.Builder> deletePlaybackConfigurationRequest) Deletes a playback configuration.deletePlaybackConfiguration
(DeletePlaybackConfigurationRequest deletePlaybackConfigurationRequest) Deletes a playback configuration.deletePrefetchSchedule
(Consumer<DeletePrefetchScheduleRequest.Builder> deletePrefetchScheduleRequest) Deletes a prefetch schedule for a specific playback configuration.deletePrefetchSchedule
(DeletePrefetchScheduleRequest deletePrefetchScheduleRequest) Deletes a prefetch schedule for a specific playback configuration.default CompletableFuture
<DeleteProgramResponse> deleteProgram
(Consumer<DeleteProgramRequest.Builder> deleteProgramRequest) Deletes a program within a channel.default CompletableFuture
<DeleteProgramResponse> deleteProgram
(DeleteProgramRequest deleteProgramRequest) Deletes a program within a channel.deleteSourceLocation
(Consumer<DeleteSourceLocationRequest.Builder> deleteSourceLocationRequest) Deletes a source location.deleteSourceLocation
(DeleteSourceLocationRequest deleteSourceLocationRequest) Deletes a source location.default CompletableFuture
<DeleteVodSourceResponse> deleteVodSource
(Consumer<DeleteVodSourceRequest.Builder> deleteVodSourceRequest) The video on demand (VOD) source to delete.default CompletableFuture
<DeleteVodSourceResponse> deleteVodSource
(DeleteVodSourceRequest deleteVodSourceRequest) The video on demand (VOD) source to delete.default CompletableFuture
<DescribeChannelResponse> describeChannel
(Consumer<DescribeChannelRequest.Builder> describeChannelRequest) Describes a channel.default CompletableFuture
<DescribeChannelResponse> describeChannel
(DescribeChannelRequest describeChannelRequest) Describes a channel.describeLiveSource
(Consumer<DescribeLiveSourceRequest.Builder> describeLiveSourceRequest) The live source to describe.describeLiveSource
(DescribeLiveSourceRequest describeLiveSourceRequest) The live source to describe.default CompletableFuture
<DescribeProgramResponse> describeProgram
(Consumer<DescribeProgramRequest.Builder> describeProgramRequest) Describes a program within a channel.default CompletableFuture
<DescribeProgramResponse> describeProgram
(DescribeProgramRequest describeProgramRequest) Describes a program within a channel.describeSourceLocation
(Consumer<DescribeSourceLocationRequest.Builder> describeSourceLocationRequest) Describes a source location.describeSourceLocation
(DescribeSourceLocationRequest describeSourceLocationRequest) Describes a source location.describeVodSource
(Consumer<DescribeVodSourceRequest.Builder> describeVodSourceRequest) Provides details about a specific video on demand (VOD) source in a specific source location.describeVodSource
(DescribeVodSourceRequest describeVodSourceRequest) Provides details about a specific video on demand (VOD) source in a specific source location.getChannelPolicy
(Consumer<GetChannelPolicyRequest.Builder> getChannelPolicyRequest) Returns the channel's IAM policy.getChannelPolicy
(GetChannelPolicyRequest getChannelPolicyRequest) Returns the channel's IAM policy.getChannelSchedule
(Consumer<GetChannelScheduleRequest.Builder> getChannelScheduleRequest) Retrieves information about your channel's schedule.getChannelSchedule
(GetChannelScheduleRequest getChannelScheduleRequest) Retrieves information about your channel's schedule.default GetChannelSchedulePublisher
getChannelSchedulePaginator
(Consumer<GetChannelScheduleRequest.Builder> getChannelScheduleRequest) This is a variant ofgetChannelSchedule(software.amazon.awssdk.services.mediatailor.model.GetChannelScheduleRequest)
operation.default GetChannelSchedulePublisher
getChannelSchedulePaginator
(GetChannelScheduleRequest getChannelScheduleRequest) This is a variant ofgetChannelSchedule(software.amazon.awssdk.services.mediatailor.model.GetChannelScheduleRequest)
operation.getPlaybackConfiguration
(Consumer<GetPlaybackConfigurationRequest.Builder> getPlaybackConfigurationRequest) Retrieves a playback configuration.getPlaybackConfiguration
(GetPlaybackConfigurationRequest getPlaybackConfigurationRequest) Retrieves a playback configuration.getPrefetchSchedule
(Consumer<GetPrefetchScheduleRequest.Builder> getPrefetchScheduleRequest) Retrieves a prefetch schedule for a playback configuration.getPrefetchSchedule
(GetPrefetchScheduleRequest getPrefetchScheduleRequest) Retrieves a prefetch schedule for a playback configuration.default CompletableFuture
<ListAlertsResponse> listAlerts
(Consumer<ListAlertsRequest.Builder> listAlertsRequest) Lists the alerts that are associated with a MediaTailor channel assembly resource.default CompletableFuture
<ListAlertsResponse> listAlerts
(ListAlertsRequest listAlertsRequest) Lists the alerts that are associated with a MediaTailor channel assembly resource.default ListAlertsPublisher
listAlertsPaginator
(Consumer<ListAlertsRequest.Builder> listAlertsRequest) This is a variant oflistAlerts(software.amazon.awssdk.services.mediatailor.model.ListAlertsRequest)
operation.default ListAlertsPublisher
listAlertsPaginator
(ListAlertsRequest listAlertsRequest) This is a variant oflistAlerts(software.amazon.awssdk.services.mediatailor.model.ListAlertsRequest)
operation.default CompletableFuture
<ListChannelsResponse> listChannels
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Retrieves information about the channels that are associated with the current AWS account.default CompletableFuture
<ListChannelsResponse> listChannels
(ListChannelsRequest listChannelsRequest) Retrieves information about the channels that are associated with the current AWS account.default ListChannelsPublisher
listChannelsPaginator
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.mediatailor.model.ListChannelsRequest)
operation.default ListChannelsPublisher
listChannelsPaginator
(ListChannelsRequest listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.mediatailor.model.ListChannelsRequest)
operation.default CompletableFuture
<ListLiveSourcesResponse> listLiveSources
(Consumer<ListLiveSourcesRequest.Builder> listLiveSourcesRequest) Lists the live sources contained in a source location.default CompletableFuture
<ListLiveSourcesResponse> listLiveSources
(ListLiveSourcesRequest listLiveSourcesRequest) Lists the live sources contained in a source location.default ListLiveSourcesPublisher
listLiveSourcesPaginator
(Consumer<ListLiveSourcesRequest.Builder> listLiveSourcesRequest) This is a variant oflistLiveSources(software.amazon.awssdk.services.mediatailor.model.ListLiveSourcesRequest)
operation.default ListLiveSourcesPublisher
listLiveSourcesPaginator
(ListLiveSourcesRequest listLiveSourcesRequest) This is a variant oflistLiveSources(software.amazon.awssdk.services.mediatailor.model.ListLiveSourcesRequest)
operation.Retrieves existing playback configurations.listPlaybackConfigurations
(Consumer<ListPlaybackConfigurationsRequest.Builder> listPlaybackConfigurationsRequest) Retrieves existing playback configurations.listPlaybackConfigurations
(ListPlaybackConfigurationsRequest listPlaybackConfigurationsRequest) Retrieves existing playback configurations.This is a variant oflistPlaybackConfigurations(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsRequest)
operation.listPlaybackConfigurationsPaginator
(Consumer<ListPlaybackConfigurationsRequest.Builder> listPlaybackConfigurationsRequest) This is a variant oflistPlaybackConfigurations(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsRequest)
operation.listPlaybackConfigurationsPaginator
(ListPlaybackConfigurationsRequest listPlaybackConfigurationsRequest) This is a variant oflistPlaybackConfigurations(software.amazon.awssdk.services.mediatailor.model.ListPlaybackConfigurationsRequest)
operation.listPrefetchSchedules
(Consumer<ListPrefetchSchedulesRequest.Builder> listPrefetchSchedulesRequest) Lists the prefetch schedules for a playback configuration.listPrefetchSchedules
(ListPrefetchSchedulesRequest listPrefetchSchedulesRequest) Lists the prefetch schedules for a playback configuration.default ListPrefetchSchedulesPublisher
listPrefetchSchedulesPaginator
(Consumer<ListPrefetchSchedulesRequest.Builder> listPrefetchSchedulesRequest) This is a variant oflistPrefetchSchedules(software.amazon.awssdk.services.mediatailor.model.ListPrefetchSchedulesRequest)
operation.default ListPrefetchSchedulesPublisher
listPrefetchSchedulesPaginator
(ListPrefetchSchedulesRequest listPrefetchSchedulesRequest) This is a variant oflistPrefetchSchedules(software.amazon.awssdk.services.mediatailor.model.ListPrefetchSchedulesRequest)
operation.listSourceLocations
(Consumer<ListSourceLocationsRequest.Builder> listSourceLocationsRequest) Lists the source locations for a channel.listSourceLocations
(ListSourceLocationsRequest listSourceLocationsRequest) Lists the source locations for a channel.default ListSourceLocationsPublisher
listSourceLocationsPaginator
(Consumer<ListSourceLocationsRequest.Builder> listSourceLocationsRequest) This is a variant oflistSourceLocations(software.amazon.awssdk.services.mediatailor.model.ListSourceLocationsRequest)
operation.default ListSourceLocationsPublisher
listSourceLocationsPaginator
(ListSourceLocationsRequest listSourceLocationsRequest) This is a variant oflistSourceLocations(software.amazon.awssdk.services.mediatailor.model.ListSourceLocationsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) A list of tags that are associated with this resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) A list of tags that are associated with this resource.default CompletableFuture
<ListVodSourcesResponse> listVodSources
(Consumer<ListVodSourcesRequest.Builder> listVodSourcesRequest) Lists the VOD sources contained in a source location.default CompletableFuture
<ListVodSourcesResponse> listVodSources
(ListVodSourcesRequest listVodSourcesRequest) Lists the VOD sources contained in a source location.default ListVodSourcesPublisher
listVodSourcesPaginator
(Consumer<ListVodSourcesRequest.Builder> listVodSourcesRequest) This is a variant oflistVodSources(software.amazon.awssdk.services.mediatailor.model.ListVodSourcesRequest)
operation.default ListVodSourcesPublisher
listVodSourcesPaginator
(ListVodSourcesRequest listVodSourcesRequest) This is a variant oflistVodSources(software.amazon.awssdk.services.mediatailor.model.ListVodSourcesRequest)
operation.putChannelPolicy
(Consumer<PutChannelPolicyRequest.Builder> putChannelPolicyRequest) Creates an IAM policy for the channel.putChannelPolicy
(PutChannelPolicyRequest putChannelPolicyRequest) Creates an IAM policy for the channel.putPlaybackConfiguration
(Consumer<PutPlaybackConfigurationRequest.Builder> putPlaybackConfigurationRequest) Creates a playback configuration.putPlaybackConfiguration
(PutPlaybackConfigurationRequest putPlaybackConfigurationRequest) Creates a playback configuration.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartChannelResponse> startChannel
(Consumer<StartChannelRequest.Builder> startChannelRequest) Starts a channel.default CompletableFuture
<StartChannelResponse> startChannel
(StartChannelRequest startChannelRequest) Starts a channel.default CompletableFuture
<StopChannelResponse> stopChannel
(Consumer<StopChannelRequest.Builder> stopChannelRequest) Stops a channel.default CompletableFuture
<StopChannelResponse> stopChannel
(StopChannelRequest stopChannelRequest) Stops a channel.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) The resource to tag.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) The resource to tag.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) The resource to untag.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) The resource to untag.default CompletableFuture
<UpdateChannelResponse> updateChannel
(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) Updates a channel.default CompletableFuture
<UpdateChannelResponse> updateChannel
(UpdateChannelRequest updateChannelRequest) Updates a channel.updateLiveSource
(Consumer<UpdateLiveSourceRequest.Builder> updateLiveSourceRequest) Updates a live source's configuration.updateLiveSource
(UpdateLiveSourceRequest updateLiveSourceRequest) Updates a live source's configuration.default CompletableFuture
<UpdateProgramResponse> updateProgram
(Consumer<UpdateProgramRequest.Builder> updateProgramRequest) Updates a program within a channel.default CompletableFuture
<UpdateProgramResponse> updateProgram
(UpdateProgramRequest updateProgramRequest) Updates a program within a channel.updateSourceLocation
(Consumer<UpdateSourceLocationRequest.Builder> updateSourceLocationRequest) Updates a source location.updateSourceLocation
(UpdateSourceLocationRequest updateSourceLocationRequest) Updates a source location.default CompletableFuture
<UpdateVodSourceResponse> updateVodSource
(Consumer<UpdateVodSourceRequest.Builder> updateVodSourceRequest) Updates a VOD source's configuration.default CompletableFuture
<UpdateVodSourceResponse> updateVodSource
(UpdateVodSourceRequest updateVodSourceRequest) Updates a VOD source's configuration.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
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 invokeThrowable.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 viaConfigureLogsForChannelRequest.builder()
- Parameters:
configureLogsForChannelRequest
- AConsumer
that will call methods onConfigureLogsForChannelRequest.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 invokeThrowable.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 invokeThrowable.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 viaConfigureLogsForPlaybackConfigurationRequest.builder()
- Parameters:
configureLogsForPlaybackConfigurationRequest
- AConsumer
that will call methods onConfigureLogsForPlaybackConfigurationRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateChannelRequest.builder()
- Parameters:
createChannelRequest
- AConsumer
that will call methods onCreateChannelRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateLiveSourceRequest.builder()
- Parameters:
createLiveSourceRequest
- AConsumer
that will call methods onCreateLiveSourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreatePrefetchScheduleRequest.builder()
- Parameters:
createPrefetchScheduleRequest
- AConsumer
that will call methods onCreatePrefetchScheduleRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateProgramRequest.builder()
- Parameters:
createProgramRequest
- AConsumer
that will call methods onCreateProgramRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateSourceLocationRequest.builder()
- Parameters:
createSourceLocationRequest
- AConsumer
that will call methods onCreateSourceLocationRequest.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 invokeThrowable.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 invokeThrowable.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 viaCreateVodSourceRequest.builder()
- Parameters:
createVodSourceRequest
- AConsumer
that will call methods onCreateVodSourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteChannelRequest.builder()
- Parameters:
deleteChannelRequest
- AConsumer
that will call methods onDeleteChannelRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteChannelPolicyRequest.builder()
- Parameters:
deleteChannelPolicyRequest
- AConsumer
that will call methods onDeleteChannelPolicyRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteLiveSourceRequest.builder()
- Parameters:
deleteLiveSourceRequest
- AConsumer
that will call methods onDeleteLiveSourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeletePlaybackConfigurationRequest.builder()
- Parameters:
deletePlaybackConfigurationRequest
- AConsumer
that will call methods onDeletePlaybackConfigurationRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeletePrefetchScheduleRequest.builder()
- Parameters:
deletePrefetchScheduleRequest
- AConsumer
that will call methods onDeletePrefetchScheduleRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteProgramRequest.builder()
- Parameters:
deleteProgramRequest
- AConsumer
that will call methods onDeleteProgramRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteSourceLocationRequest.builder()
- Parameters:
deleteSourceLocationRequest
- AConsumer
that will call methods onDeleteSourceLocationRequest.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 invokeThrowable.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 invokeThrowable.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 viaDeleteVodSourceRequest.builder()
- Parameters:
deleteVodSourceRequest
- AConsumer
that will call methods onDeleteVodSourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaDescribeChannelRequest.builder()
- Parameters:
describeChannelRequest
- AConsumer
that will call methods onDescribeChannelRequest.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 invokeThrowable.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 invokeThrowable.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 viaDescribeLiveSourceRequest.builder()
- Parameters:
describeLiveSourceRequest
- AConsumer
that will call methods onDescribeLiveSourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaDescribeProgramRequest.builder()
- Parameters:
describeProgramRequest
- AConsumer
that will call methods onDescribeProgramRequest.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 invokeThrowable.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 invokeThrowable.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 viaDescribeSourceLocationRequest.builder()
- Parameters:
describeSourceLocationRequest
- AConsumer
that will call methods onDescribeSourceLocationRequest.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 invokeThrowable.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 invokeThrowable.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 viaDescribeVodSourceRequest.builder()
- Parameters:
describeVodSourceRequest
- AConsumer
that will call methods onDescribeVodSourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetChannelPolicyRequest.builder()
- Parameters:
getChannelPolicyRequest
- AConsumer
that will call methods onGetChannelPolicyRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetChannelScheduleRequest.builder()
- Parameters:
getChannelScheduleRequest
- AConsumer
that will call methods onGetChannelScheduleRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.GetChannelSchedulePublisher publisher = client.getChannelSchedulePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.GetChannelSchedulePublisher publisher = client.getChannelSchedulePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetChannelScheduleRequest.builder()
- Parameters:
getChannelScheduleRequest
- AConsumer
that will call methods onGetChannelScheduleRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetPlaybackConfigurationRequest.builder()
- Parameters:
getPlaybackConfigurationRequest
- AConsumer
that will call methods onGetPlaybackConfigurationRequest.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 invokeThrowable.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 invokeThrowable.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 viaGetPrefetchScheduleRequest.builder()
- Parameters:
getPrefetchScheduleRequest
- AConsumer
that will call methods onGetPrefetchScheduleRequest.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 invokeThrowable.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
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 invokeThrowable.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 viaListAlertsRequest.builder()
- Parameters:
listAlertsRequest
- AConsumer
that will call methods onListAlertsRequest.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 invokeThrowable.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
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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListAlertsPublisher publisher = client.listAlertsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListAlertsPublisher publisher = client.listAlertsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListAlertsRequest.builder()
- Parameters:
listAlertsRequest
- AConsumer
that will call methods onListAlertsRequest.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 invokeThrowable.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 invokeThrowable.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 viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.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 invokeThrowable.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
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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.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 invokeThrowable.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 invokeThrowable.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 viaListLiveSourcesRequest.builder()
- Parameters:
listLiveSourcesRequest
- AConsumer
that will call methods onListLiveSourcesRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListLiveSourcesPublisher publisher = client.listLiveSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListLiveSourcesPublisher publisher = client.listLiveSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListLiveSourcesRequest.builder()
- Parameters:
listLiveSourcesRequest
- AConsumer
that will call methods onListLiveSourcesRequest.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 invokeThrowable.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 invokeThrowable.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 viaListPlaybackConfigurationsRequest.builder()
- Parameters:
listPlaybackConfigurationsRequest
- AConsumer
that will call methods onListPlaybackConfigurationsRequest.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 invokeThrowable.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
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 invokeThrowable.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
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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListPlaybackConfigurationsPublisher publisher = client.listPlaybackConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListPlaybackConfigurationsPublisher publisher = client.listPlaybackConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListPlaybackConfigurationsPublisher publisher = client.listPlaybackConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListPlaybackConfigurationsRequest.builder()
- Parameters:
listPlaybackConfigurationsRequest
- AConsumer
that will call methods onListPlaybackConfigurationsRequest.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 invokeThrowable.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 invokeThrowable.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 viaListPrefetchSchedulesRequest.builder()
- Parameters:
listPrefetchSchedulesRequest
- AConsumer
that will call methods onListPrefetchSchedulesRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListPrefetchSchedulesPublisher publisher = client.listPrefetchSchedulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListPrefetchSchedulesPublisher publisher = client.listPrefetchSchedulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListPrefetchSchedulesRequest.builder()
- Parameters:
listPrefetchSchedulesRequest
- AConsumer
that will call methods onListPrefetchSchedulesRequest.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 invokeThrowable.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 invokeThrowable.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 viaListSourceLocationsRequest.builder()
- Parameters:
listSourceLocationsRequest
- AConsumer
that will call methods onListSourceLocationsRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListSourceLocationsPublisher publisher = client.listSourceLocationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListSourceLocationsPublisher publisher = client.listSourceLocationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListSourceLocationsRequest.builder()
- Parameters:
listSourceLocationsRequest
- AConsumer
that will call methods onListSourceLocationsRequest.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 invokeThrowable.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 invokeThrowable.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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaListVodSourcesRequest.builder()
- Parameters:
listVodSourcesRequest
- AConsumer
that will call methods onListVodSourcesRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListVodSourcesPublisher publisher = client.listVodSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.mediatailor.paginators.ListVodSourcesPublisher publisher = client.listVodSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListVodSourcesRequest.builder()
- Parameters:
listVodSourcesRequest
- AConsumer
that will call methods onListVodSourcesRequest.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 invokeThrowable.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 invokeThrowable.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 viaPutChannelPolicyRequest.builder()
- Parameters:
putChannelPolicyRequest
- AConsumer
that will call methods onPutChannelPolicyRequest.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 invokeThrowable.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 invokeThrowable.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 viaPutPlaybackConfigurationRequest.builder()
- Parameters:
putPlaybackConfigurationRequest
- AConsumer
that will call methods onPutPlaybackConfigurationRequest.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 invokeThrowable.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 invokeThrowable.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 viaStartChannelRequest.builder()
- Parameters:
startChannelRequest
- AConsumer
that will call methods onStartChannelRequest.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 invokeThrowable.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
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 invokeThrowable.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 viaStopChannelRequest.builder()
- Parameters:
stopChannelRequest
- AConsumer
that will call methods onStopChannelRequest.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 invokeThrowable.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
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 invokeThrowable.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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateChannelRequest.builder()
- Parameters:
updateChannelRequest
- AConsumer
that will call methods onUpdateChannelRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateLiveSourceRequest.builder()
- Parameters:
updateLiveSourceRequest
- AConsumer
that will call methods onUpdateLiveSourceRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateProgramRequest.builder()
- Parameters:
updateProgramRequest
- AConsumer
that will call methods onUpdateProgramRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateSourceLocationRequest.builder()
- Parameters:
updateSourceLocationRequest
- AConsumer
that will call methods onUpdateSourceLocationRequest.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 invokeThrowable.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 invokeThrowable.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 viaUpdateVodSourceRequest.builder()
- Parameters:
updateVodSourceRequest
- AConsumer
that will call methods onUpdateVodSourceRequest.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 invokeThrowable.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
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aMediaTailorAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMediaTailorAsyncClient
.
-