software.amazon.awssdk.services.kinesisvideo.KinesisVideoAsyncClient Maven / Gradle / Ivy
Show all versions of kinesisvideo Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.kinesisvideo;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.kinesisvideo.model.CreateSignalingChannelRequest;
import software.amazon.awssdk.services.kinesisvideo.model.CreateSignalingChannelResponse;
import software.amazon.awssdk.services.kinesisvideo.model.CreateStreamRequest;
import software.amazon.awssdk.services.kinesisvideo.model.CreateStreamResponse;
import software.amazon.awssdk.services.kinesisvideo.model.DeleteEdgeConfigurationRequest;
import software.amazon.awssdk.services.kinesisvideo.model.DeleteEdgeConfigurationResponse;
import software.amazon.awssdk.services.kinesisvideo.model.DeleteSignalingChannelRequest;
import software.amazon.awssdk.services.kinesisvideo.model.DeleteSignalingChannelResponse;
import software.amazon.awssdk.services.kinesisvideo.model.DeleteStreamRequest;
import software.amazon.awssdk.services.kinesisvideo.model.DeleteStreamResponse;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeEdgeConfigurationRequest;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeEdgeConfigurationResponse;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeImageGenerationConfigurationRequest;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeImageGenerationConfigurationResponse;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeMediaStorageConfigurationRequest;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeMediaStorageConfigurationResponse;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeNotificationConfigurationRequest;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeNotificationConfigurationResponse;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeSignalingChannelRequest;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeSignalingChannelResponse;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeStreamRequest;
import software.amazon.awssdk.services.kinesisvideo.model.DescribeStreamResponse;
import software.amazon.awssdk.services.kinesisvideo.model.GetDataEndpointRequest;
import software.amazon.awssdk.services.kinesisvideo.model.GetDataEndpointResponse;
import software.amazon.awssdk.services.kinesisvideo.model.GetSignalingChannelEndpointRequest;
import software.amazon.awssdk.services.kinesisvideo.model.GetSignalingChannelEndpointResponse;
import software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest;
import software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse;
import software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest;
import software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse;
import software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest;
import software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse;
import software.amazon.awssdk.services.kinesisvideo.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.kinesisvideo.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.kinesisvideo.model.ListTagsForStreamRequest;
import software.amazon.awssdk.services.kinesisvideo.model.ListTagsForStreamResponse;
import software.amazon.awssdk.services.kinesisvideo.model.StartEdgeConfigurationUpdateRequest;
import software.amazon.awssdk.services.kinesisvideo.model.StartEdgeConfigurationUpdateResponse;
import software.amazon.awssdk.services.kinesisvideo.model.TagResourceRequest;
import software.amazon.awssdk.services.kinesisvideo.model.TagResourceResponse;
import software.amazon.awssdk.services.kinesisvideo.model.TagStreamRequest;
import software.amazon.awssdk.services.kinesisvideo.model.TagStreamResponse;
import software.amazon.awssdk.services.kinesisvideo.model.UntagResourceRequest;
import software.amazon.awssdk.services.kinesisvideo.model.UntagResourceResponse;
import software.amazon.awssdk.services.kinesisvideo.model.UntagStreamRequest;
import software.amazon.awssdk.services.kinesisvideo.model.UntagStreamResponse;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateDataRetentionRequest;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateDataRetentionResponse;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateImageGenerationConfigurationRequest;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateImageGenerationConfigurationResponse;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateMediaStorageConfigurationRequest;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateMediaStorageConfigurationResponse;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateNotificationConfigurationRequest;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateNotificationConfigurationResponse;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateSignalingChannelRequest;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateSignalingChannelResponse;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateStreamRequest;
import software.amazon.awssdk.services.kinesisvideo.model.UpdateStreamResponse;
import software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationPublisher;
import software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsPublisher;
import software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsPublisher;
import software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher;
/**
* Service client for accessing Kinesis Video asynchronously. This can be created using the static {@link #builder()}
* method.The asynchronous client performs non-blocking I/O when configured with any {@code SdkAsyncHttpClient}
* supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
* some cases such as credentials retrieval and endpoint discovery as part of the async API call.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface KinesisVideoAsyncClient extends AwsClient {
String SERVICE_NAME = "kinesisvideo";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "kinesisvideo";
/**
*
* Creates a signaling channel.
*
*
* CreateSignalingChannel is an asynchronous operation.
*
*
* @param createSignalingChannelRequest
* @return A Java Future containing the result of the CreateSignalingChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - AccountChannelLimitExceededException You have reached the maximum limit of active signaling channels
* for this Amazon Web Services account in this region.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - TagsPerResourceExceededLimitException You have exceeded the limit of tags that you can associate with
* the resource. A Kinesis video stream can support up to 50 tags.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.CreateSignalingChannel
* @see AWS API Documentation
*/
default CompletableFuture createSignalingChannel(
CreateSignalingChannelRequest createSignalingChannelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a signaling channel.
*
*
* CreateSignalingChannel is an asynchronous operation.
*
*
*
* This is a convenience which creates an instance of the {@link CreateSignalingChannelRequest.Builder} avoiding the
* need to create one manually via {@link CreateSignalingChannelRequest#builder()}
*
*
* @param createSignalingChannelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.CreateSignalingChannelRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the CreateSignalingChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - AccountChannelLimitExceededException You have reached the maximum limit of active signaling channels
* for this Amazon Web Services account in this region.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - TagsPerResourceExceededLimitException You have exceeded the limit of tags that you can associate with
* the resource. A Kinesis video stream can support up to 50 tags.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.CreateSignalingChannel
* @see AWS API Documentation
*/
default CompletableFuture createSignalingChannel(
Consumer createSignalingChannelRequest) {
return createSignalingChannel(CreateSignalingChannelRequest.builder().applyMutation(createSignalingChannelRequest)
.build());
}
/**
*
* Creates a new Kinesis video stream.
*
*
* When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's
* metadata, Kinesis Video Streams updates the version.
*
*
* CreateStream is an asynchronous operation.
*
*
* For information about how the service works, see How it Works.
*
*
* You must have permissions for the KinesisVideo:CreateStream action.
*
*
* @param createStreamRequest
* @return A Java Future containing the result of the CreateStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccountStreamLimitExceededException The number of streams created for the account is too high.
* - DeviceStreamLimitExceededException Not implemented.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - InvalidDeviceException Not implemented.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - TagsPerResourceExceededLimitException You have exceeded the limit of tags that you can associate with
* the resource. A Kinesis video stream can support up to 50 tags.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.CreateStream
* @see AWS API
* Documentation
*/
default CompletableFuture createStream(CreateStreamRequest createStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new Kinesis video stream.
*
*
* When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's
* metadata, Kinesis Video Streams updates the version.
*
*
* CreateStream is an asynchronous operation.
*
*
* For information about how the service works, see How it Works.
*
*
* You must have permissions for the KinesisVideo:CreateStream action.
*
*
*
* This is a convenience which creates an instance of the {@link CreateStreamRequest.Builder} avoiding the need to
* create one manually via {@link CreateStreamRequest#builder()}
*
*
* @param createStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.CreateStreamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccountStreamLimitExceededException The number of streams created for the account is too high.
* - DeviceStreamLimitExceededException Not implemented.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - InvalidDeviceException Not implemented.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - TagsPerResourceExceededLimitException You have exceeded the limit of tags that you can associate with
* the resource. A Kinesis video stream can support up to 50 tags.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.CreateStream
* @see AWS API
* Documentation
*/
default CompletableFuture createStream(Consumer createStreamRequest) {
return createStream(CreateStreamRequest.builder().applyMutation(createStreamRequest).build());
}
/**
*
* An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from
* the Edge Agent.
*
*
* When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which
* active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending
* on the total amount of stored media. If the deletion process fails, the sync status changes to
* DELETE_FAILED. You will need to re-try the deletion.
*
*
* When the deletion process has completed successfully, the edge configuration is no longer accessible.
*
*
* @param deleteEdgeConfigurationRequest
* @return A Java Future containing the result of the DeleteEdgeConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - StreamEdgeConfigurationNotFoundException The Exception rendered when the Amazon Kinesis Video Stream
* can't find a stream's edge configuration that you specified.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DeleteEdgeConfiguration
* @see AWS API Documentation
*/
default CompletableFuture deleteEdgeConfiguration(
DeleteEdgeConfigurationRequest deleteEdgeConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from
* the Edge Agent.
*
*
* When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which
* active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending
* on the total amount of stored media. If the deletion process fails, the sync status changes to
* DELETE_FAILED. You will need to re-try the deletion.
*
*
* When the deletion process has completed successfully, the edge configuration is no longer accessible.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteEdgeConfigurationRequest.Builder} avoiding
* the need to create one manually via {@link DeleteEdgeConfigurationRequest#builder()}
*
*
* @param deleteEdgeConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DeleteEdgeConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteEdgeConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - StreamEdgeConfigurationNotFoundException The Exception rendered when the Amazon Kinesis Video Stream
* can't find a stream's edge configuration that you specified.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DeleteEdgeConfiguration
* @see AWS API Documentation
*/
default CompletableFuture deleteEdgeConfiguration(
Consumer deleteEdgeConfigurationRequest) {
return deleteEdgeConfiguration(DeleteEdgeConfigurationRequest.builder().applyMutation(deleteEdgeConfigurationRequest)
.build());
}
/**
*
* Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you
* don't specify the channel's current version, the most recent version is deleted.
*
*
* @param deleteSignalingChannelRequest
* @return A Java Future containing the result of the DeleteSignalingChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - VersionMismatchException The stream version that you specified is not the latest version. To get the
* latest version, use the DescribeStream API.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DeleteSignalingChannel
* @see AWS API Documentation
*/
default CompletableFuture deleteSignalingChannel(
DeleteSignalingChannelRequest deleteSignalingChannelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you
* don't specify the channel's current version, the most recent version is deleted.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteSignalingChannelRequest.Builder} avoiding the
* need to create one manually via {@link DeleteSignalingChannelRequest#builder()}
*
*
* @param deleteSignalingChannelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DeleteSignalingChannelRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DeleteSignalingChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - VersionMismatchException The stream version that you specified is not the latest version. To get the
* latest version, use the DescribeStream API.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DeleteSignalingChannel
* @see AWS API Documentation
*/
default CompletableFuture deleteSignalingChannel(
Consumer deleteSignalingChannelRequest) {
return deleteSignalingChannel(DeleteSignalingChannelRequest.builder().applyMutation(deleteSignalingChannelRequest)
.build());
}
/**
*
* Deletes a Kinesis video stream and the data contained in the stream.
*
*
* This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.
*
*
*
*
* To ensure that you have the latest version of the stream before deleting it, you can specify the stream version.
* Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a
* new version number. To get the latest stream version, use the DescribeStream API.
*
*
* This operation requires permission for the KinesisVideo:DeleteStream action.
*
*
* @param deleteStreamRequest
* @return A Java Future containing the result of the DeleteStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - VersionMismatchException The stream version that you specified is not the latest version. To get the
* latest version, use the DescribeStream API.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DeleteStream
* @see AWS API
* Documentation
*/
default CompletableFuture deleteStream(DeleteStreamRequest deleteStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a Kinesis video stream and the data contained in the stream.
*
*
* This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.
*
*
*
*
* To ensure that you have the latest version of the stream before deleting it, you can specify the stream version.
* Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a
* new version number. To get the latest stream version, use the DescribeStream API.
*
*
* This operation requires permission for the KinesisVideo:DeleteStream action.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteStreamRequest.Builder} avoiding the need to
* create one manually via {@link DeleteStreamRequest#builder()}
*
*
* @param deleteStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DeleteStreamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - VersionMismatchException The stream version that you specified is not the latest version. To get the
* latest version, use the DescribeStream API.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DeleteStream
* @see AWS API
* Documentation
*/
default CompletableFuture deleteStream(Consumer deleteStreamRequest) {
return deleteStream(DeleteStreamRequest.builder().applyMutation(deleteStreamRequest).build());
}
/**
*
* Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and
* the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the
* configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the
* health of the Edge Agent.
*
*
* @param describeEdgeConfigurationRequest
* @return A Java Future containing the result of the DescribeEdgeConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - StreamEdgeConfigurationNotFoundException The Exception rendered when the Amazon Kinesis Video Stream
* can't find a stream's edge configuration that you specified.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeEdgeConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeEdgeConfiguration(
DescribeEdgeConfigurationRequest describeEdgeConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and
* the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the
* configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the
* health of the Edge Agent.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEdgeConfigurationRequest.Builder} avoiding
* the need to create one manually via {@link DescribeEdgeConfigurationRequest#builder()}
*
*
* @param describeEdgeConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DescribeEdgeConfigurationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeEdgeConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - StreamEdgeConfigurationNotFoundException The Exception rendered when the Amazon Kinesis Video Stream
* can't find a stream's edge configuration that you specified.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeEdgeConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeEdgeConfiguration(
Consumer describeEdgeConfigurationRequest) {
return describeEdgeConfiguration(DescribeEdgeConfigurationRequest.builder()
.applyMutation(describeEdgeConfigurationRequest).build());
}
/**
*
* Gets the ImageGenerationConfiguration for a given Kinesis video stream.
*
*
* @param describeImageGenerationConfigurationRequest
* @return A Java Future containing the result of the DescribeImageGenerationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeImageGenerationConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeImageGenerationConfiguration(
DescribeImageGenerationConfigurationRequest describeImageGenerationConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the ImageGenerationConfiguration for a given Kinesis video stream.
*
*
*
* This is a convenience which creates an instance of the
* {@link DescribeImageGenerationConfigurationRequest.Builder} avoiding the need to create one manually via
* {@link DescribeImageGenerationConfigurationRequest#builder()}
*
*
* @param describeImageGenerationConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DescribeImageGenerationConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DescribeImageGenerationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeImageGenerationConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeImageGenerationConfiguration(
Consumer describeImageGenerationConfigurationRequest) {
return describeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest.builder()
.applyMutation(describeImageGenerationConfigurationRequest).build());
}
/**
*
* Returns the most current information about the stream. The streamName or streamARN
* should be provided in the input.
*
*
* @param describeMappedResourceConfigurationRequest
* @return A Java Future containing the result of the DescribeMappedResourceConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - InvalidArgumentException The value for this input parameter is invalid.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeMappedResourceConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeMappedResourceConfiguration(
DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the most current information about the stream. The streamName or streamARN
* should be provided in the input.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeMappedResourceConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DescribeMappedResourceConfigurationRequest#builder()}
*
*
* @param describeMappedResourceConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DescribeMappedResourceConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - InvalidArgumentException The value for this input parameter is invalid.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeMappedResourceConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeMappedResourceConfiguration(
Consumer describeMappedResourceConfigurationRequest) {
return describeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest.builder()
.applyMutation(describeMappedResourceConfigurationRequest).build());
}
/**
*
* This is a variant of
* {@link #describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationPublisher publisher = client.describeMappedResourceConfigurationPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationPublisher publisher = client.describeMappedResourceConfigurationPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest)}
* operation.
*
*
* @param describeMappedResourceConfigurationRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - InvalidArgumentException The value for this input parameter is invalid.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeMappedResourceConfiguration
* @see AWS API Documentation
*/
default DescribeMappedResourceConfigurationPublisher describeMappedResourceConfigurationPaginator(
DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest) {
return new DescribeMappedResourceConfigurationPublisher(this, describeMappedResourceConfigurationRequest);
}
/**
*
* This is a variant of
* {@link #describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationPublisher publisher = client.describeMappedResourceConfigurationPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationPublisher publisher = client.describeMappedResourceConfigurationPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeMappedResourceConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DescribeMappedResourceConfigurationRequest#builder()}
*
*
* @param describeMappedResourceConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest.Builder}
* to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - InvalidArgumentException The value for this input parameter is invalid.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeMappedResourceConfiguration
* @see AWS API Documentation
*/
default DescribeMappedResourceConfigurationPublisher describeMappedResourceConfigurationPaginator(
Consumer describeMappedResourceConfigurationRequest) {
return describeMappedResourceConfigurationPaginator(DescribeMappedResourceConfigurationRequest.builder()
.applyMutation(describeMappedResourceConfigurationRequest).build());
}
/**
*
* Returns the most current information about the channel. Specify the ChannelName or
* ChannelARN in the input.
*
*
* @param describeMediaStorageConfigurationRequest
* @return A Java Future containing the result of the DescribeMediaStorageConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - InvalidArgumentException The value for this input parameter is invalid.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeMediaStorageConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeMediaStorageConfiguration(
DescribeMediaStorageConfigurationRequest describeMediaStorageConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the most current information about the channel. Specify the ChannelName or
* ChannelARN in the input.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeMediaStorageConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DescribeMediaStorageConfigurationRequest#builder()}
*
*
* @param describeMediaStorageConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DescribeMediaStorageConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DescribeMediaStorageConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - InvalidArgumentException The value for this input parameter is invalid.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeMediaStorageConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeMediaStorageConfiguration(
Consumer describeMediaStorageConfigurationRequest) {
return describeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest.builder()
.applyMutation(describeMediaStorageConfigurationRequest).build());
}
/**
*
* Gets the NotificationConfiguration for a given Kinesis video stream.
*
*
* @param describeNotificationConfigurationRequest
* @return A Java Future containing the result of the DescribeNotificationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeNotificationConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeNotificationConfiguration(
DescribeNotificationConfigurationRequest describeNotificationConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the NotificationConfiguration for a given Kinesis video stream.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeNotificationConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DescribeNotificationConfigurationRequest#builder()}
*
*
* @param describeNotificationConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DescribeNotificationConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DescribeNotificationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeNotificationConfiguration
* @see AWS API Documentation
*/
default CompletableFuture describeNotificationConfiguration(
Consumer describeNotificationConfigurationRequest) {
return describeNotificationConfiguration(DescribeNotificationConfigurationRequest.builder()
.applyMutation(describeNotificationConfigurationRequest).build());
}
/**
*
* Returns the most current information about the signaling channel. You must specify either the name or the Amazon
* Resource Name (ARN) of the channel that you want to describe.
*
*
* @param describeSignalingChannelRequest
* @return A Java Future containing the result of the DescribeSignalingChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeSignalingChannel
* @see AWS API Documentation
*/
default CompletableFuture describeSignalingChannel(
DescribeSignalingChannelRequest describeSignalingChannelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the most current information about the signaling channel. You must specify either the name or the Amazon
* Resource Name (ARN) of the channel that you want to describe.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSignalingChannelRequest.Builder} avoiding
* the need to create one manually via {@link DescribeSignalingChannelRequest#builder()}
*
*
* @param describeSignalingChannelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DescribeSignalingChannelRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeSignalingChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeSignalingChannel
* @see AWS API Documentation
*/
default CompletableFuture describeSignalingChannel(
Consumer describeSignalingChannelRequest) {
return describeSignalingChannel(DescribeSignalingChannelRequest.builder().applyMutation(describeSignalingChannelRequest)
.build());
}
/**
*
* Returns the most current information about the specified stream. You must specify either the
* StreamName or the StreamARN.
*
*
* @param describeStreamRequest
* @return A Java Future containing the result of the DescribeStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeStream
* @see AWS
* API Documentation
*/
default CompletableFuture describeStream(DescribeStreamRequest describeStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the most current information about the specified stream. You must specify either the
* StreamName or the StreamARN.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeStreamRequest.Builder} avoiding the need to
* create one manually via {@link DescribeStreamRequest#builder()}
*
*
* @param describeStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.DescribeStreamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.DescribeStream
* @see AWS
* API Documentation
*/
default CompletableFuture describeStream(Consumer describeStreamRequest) {
return describeStream(DescribeStreamRequest.builder().applyMutation(describeStreamRequest).build());
}
/**
*
* Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to
* read from the specified stream (using the GetMedia or GetMediaForFragmentList
* operations) or write to it (using the PutMedia operation).
*
*
*
* The returned endpoint does not have the API name appended. The client needs to add the API name to the returned
* endpoint.
*
*
*
* In the request, specify the stream either by StreamName or StreamARN.
*
*
* @param getDataEndpointRequest
* @return A Java Future containing the result of the GetDataEndpoint operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.GetDataEndpoint
* @see AWS
* API Documentation
*/
default CompletableFuture getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to
* read from the specified stream (using the GetMedia or GetMediaForFragmentList
* operations) or write to it (using the PutMedia operation).
*
*
*
* The returned endpoint does not have the API name appended. The client needs to add the API name to the returned
* endpoint.
*
*
*
* In the request, specify the stream either by StreamName or StreamARN.
*
*
*
* This is a convenience which creates an instance of the {@link GetDataEndpointRequest.Builder} avoiding the need
* to create one manually via {@link GetDataEndpointRequest#builder()}
*
*
* @param getDataEndpointRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.GetDataEndpointRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetDataEndpoint operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.GetDataEndpoint
* @see AWS
* API Documentation
*/
default CompletableFuture getDataEndpoint(
Consumer getDataEndpointRequest) {
return getDataEndpoint(GetDataEndpointRequest.builder().applyMutation(getDataEndpointRequest).build());
}
/**
*
* Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the
* SingleMasterChannelEndpointConfiguration input parameter, which consists of the
* Protocols and Role properties.
*
*
* Protocols is used to determine the communication mechanism. For example, if you specify
* WSS as the protocol, this API produces a secure websocket endpoint. If you specify
* HTTPS as the protocol, this API generates an HTTPS endpoint.
*
*
* Role determines the messaging permissions. A MASTER role results in this API generating
* an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER
* role results in this API generating an endpoint that a client can use to communicate only with a
* MASTER.
*
*
* @param getSignalingChannelEndpointRequest
* @return A Java Future containing the result of the GetSignalingChannelEndpoint operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.GetSignalingChannelEndpoint
* @see AWS API Documentation
*/
default CompletableFuture getSignalingChannelEndpoint(
GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the
* SingleMasterChannelEndpointConfiguration input parameter, which consists of the
* Protocols and Role properties.
*
*
* Protocols is used to determine the communication mechanism. For example, if you specify
* WSS as the protocol, this API produces a secure websocket endpoint. If you specify
* HTTPS as the protocol, this API generates an HTTPS endpoint.
*
*
* Role determines the messaging permissions. A MASTER role results in this API generating
* an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER
* role results in this API generating an endpoint that a client can use to communicate only with a
* MASTER.
*
*
*
* This is a convenience which creates an instance of the {@link GetSignalingChannelEndpointRequest.Builder}
* avoiding the need to create one manually via {@link GetSignalingChannelEndpointRequest#builder()}
*
*
* @param getSignalingChannelEndpointRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.GetSignalingChannelEndpointRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the GetSignalingChannelEndpoint operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.GetSignalingChannelEndpoint
* @see AWS API Documentation
*/
default CompletableFuture getSignalingChannelEndpoint(
Consumer getSignalingChannelEndpointRequest) {
return getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest.builder()
.applyMutation(getSignalingChannelEndpointRequest).build());
}
/**
*
* Returns an array of edge configurations associated with the specified Edge Agent.
*
*
* In the request, you must specify the Edge Agent HubDeviceArn.
*
*
* @param listEdgeAgentConfigurationsRequest
* @return A Java Future containing the result of the ListEdgeAgentConfigurations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListEdgeAgentConfigurations
* @see AWS API Documentation
*/
default CompletableFuture listEdgeAgentConfigurations(
ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns an array of edge configurations associated with the specified Edge Agent.
*
*
* In the request, you must specify the Edge Agent HubDeviceArn.
*
*
*
* This is a convenience which creates an instance of the {@link ListEdgeAgentConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListEdgeAgentConfigurationsRequest#builder()}
*
*
* @param listEdgeAgentConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListEdgeAgentConfigurations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListEdgeAgentConfigurations
* @see AWS API Documentation
*/
default CompletableFuture listEdgeAgentConfigurations(
Consumer listEdgeAgentConfigurationsRequest) {
return listEdgeAgentConfigurations(ListEdgeAgentConfigurationsRequest.builder()
.applyMutation(listEdgeAgentConfigurationsRequest).build());
}
/**
*
* This is a variant of
* {@link #listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsPublisher publisher = client.listEdgeAgentConfigurationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsPublisher publisher = client.listEdgeAgentConfigurationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)}
* operation.
*
*
* @param listEdgeAgentConfigurationsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListEdgeAgentConfigurations
* @see AWS API Documentation
*/
default ListEdgeAgentConfigurationsPublisher listEdgeAgentConfigurationsPaginator(
ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest) {
return new ListEdgeAgentConfigurationsPublisher(this, listEdgeAgentConfigurationsRequest);
}
/**
*
* This is a variant of
* {@link #listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsPublisher publisher = client.listEdgeAgentConfigurationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsPublisher publisher = client.listEdgeAgentConfigurationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListEdgeAgentConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListEdgeAgentConfigurationsRequest#builder()}
*
*
* @param listEdgeAgentConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListEdgeAgentConfigurations
* @see AWS API Documentation
*/
default ListEdgeAgentConfigurationsPublisher listEdgeAgentConfigurationsPaginator(
Consumer listEdgeAgentConfigurationsRequest) {
return listEdgeAgentConfigurationsPaginator(ListEdgeAgentConfigurationsRequest.builder()
.applyMutation(listEdgeAgentConfigurationsRequest).build());
}
/**
*
* Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only
* those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
*
*
* @param listSignalingChannelsRequest
* @return A Java Future containing the result of the ListSignalingChannels operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListSignalingChannels
* @see AWS API Documentation
*/
default CompletableFuture listSignalingChannels(
ListSignalingChannelsRequest listSignalingChannelsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only
* those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
*
*
*
* This is a convenience which creates an instance of the {@link ListSignalingChannelsRequest.Builder} avoiding the
* need to create one manually via {@link ListSignalingChannelsRequest#builder()}
*
*
* @param listSignalingChannelsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the ListSignalingChannels operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListSignalingChannels
* @see AWS API Documentation
*/
default CompletableFuture listSignalingChannels(
Consumer listSignalingChannelsRequest) {
return listSignalingChannels(ListSignalingChannelsRequest.builder().applyMutation(listSignalingChannelsRequest).build());
}
/**
*
* This is a variant of
* {@link #listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsPublisher publisher = client.listSignalingChannelsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsPublisher publisher = client.listSignalingChannelsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)}
* operation.
*
*
* @param listSignalingChannelsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListSignalingChannels
* @see AWS API Documentation
*/
default ListSignalingChannelsPublisher listSignalingChannelsPaginator(
ListSignalingChannelsRequest listSignalingChannelsRequest) {
return new ListSignalingChannelsPublisher(this, listSignalingChannelsRequest);
}
/**
*
* This is a variant of
* {@link #listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsPublisher publisher = client.listSignalingChannelsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsPublisher publisher = client.listSignalingChannelsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListSignalingChannelsRequest.Builder} avoiding the
* need to create one manually via {@link ListSignalingChannelsRequest#builder()}
*
*
* @param listSignalingChannelsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest.Builder} to create
* a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListSignalingChannels
* @see AWS API Documentation
*/
default ListSignalingChannelsPublisher listSignalingChannelsPaginator(
Consumer listSignalingChannelsRequest) {
return listSignalingChannelsPaginator(ListSignalingChannelsRequest.builder().applyMutation(listSignalingChannelsRequest)
.build());
}
/**
*
* Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams
* that satisfy a specific condition, you can specify a StreamNameCondition.
*
*
* @param listStreamsRequest
* @return A Java Future containing the result of the ListStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListStreams
* @see AWS API
* Documentation
*/
default CompletableFuture listStreams(ListStreamsRequest listStreamsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams
* that satisfy a specific condition, you can specify a StreamNameCondition.
*
*
*
* This is a convenience which creates an instance of the {@link ListStreamsRequest.Builder} avoiding the need to
* create one manually via {@link ListStreamsRequest#builder()}
*
*
* @param listStreamsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListStreams
* @see AWS API
* Documentation
*/
default CompletableFuture listStreams(Consumer listStreamsRequest) {
return listStreams(ListStreamsRequest.builder().applyMutation(listStreamsRequest).build());
}
/**
*
* Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams
* that satisfy a specific condition, you can specify a StreamNameCondition.
*
*
* @return A Java Future containing the result of the ListStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListStreams
* @see AWS API
* Documentation
*/
default CompletableFuture listStreams() {
return listStreams(ListStreamsRequest.builder().build());
}
/**
*
* This is a variant of {@link #listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListStreams
* @see AWS API
* Documentation
*/
default ListStreamsPublisher listStreamsPaginator() {
return listStreamsPaginator(ListStreamsRequest.builder().build());
}
/**
*
* This is a variant of {@link #listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)} operation.
*
*
* @param listStreamsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListStreams
* @see AWS API
* Documentation
*/
default ListStreamsPublisher listStreamsPaginator(ListStreamsRequest listStreamsRequest) {
return new ListStreamsPublisher(this, listStreamsRequest);
}
/**
*
* This is a variant of {@link #listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStreamsRequest.Builder} avoiding the need to
* create one manually via {@link ListStreamsRequest#builder()}
*
*
* @param listStreamsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListStreams
* @see AWS API
* Documentation
*/
default ListStreamsPublisher listStreamsPaginator(Consumer listStreamsRequest) {
return listStreamsPaginator(ListStreamsRequest.builder().applyMutation(listStreamsRequest).build());
}
/**
*
* Returns a list of tags associated with the specified signaling channel.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of tags associated with the specified signaling channel.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.ListTagsForResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Returns a list of tags associated with the specified stream.
*
*
* In the request, you must specify either the StreamName or the StreamARN.
*
*
* @param listTagsForStreamRequest
* @return A Java Future containing the result of the ListTagsForStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - InvalidResourceFormatException The format of the
StreamARN is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListTagsForStream
* @see AWS API Documentation
*/
default CompletableFuture listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of tags associated with the specified stream.
*
*
* In the request, you must specify either the StreamName or the StreamARN.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForStreamRequest.Builder} avoiding the need
* to create one manually via {@link ListTagsForStreamRequest#builder()}
*
*
* @param listTagsForStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.ListTagsForStreamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListTagsForStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - InvalidResourceFormatException The format of the
StreamARN is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.ListTagsForStream
* @see AWS API Documentation
*/
default CompletableFuture listTagsForStream(
Consumer listTagsForStreamRequest) {
return listTagsForStream(ListTagsForStreamRequest.builder().applyMutation(listTagsForStreamRequest).build());
}
/**
*
* An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the
* stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at
* your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The
* SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge
* Agent.
*
*
* If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync
* status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state
* such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API
* during the syncing process, a ResourceInUseException will be thrown. The connectivity of the
* stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will
* transition into the SYNC_FAILED state.
*
*
* To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the
* current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.
*
*
* @param startEdgeConfigurationUpdateRequest
* @return A Java Future containing the result of the StartEdgeConfigurationUpdate operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - NoDataRetentionException The Stream data retention in hours is equal to zero.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.StartEdgeConfigurationUpdate
* @see AWS API Documentation
*/
default CompletableFuture startEdgeConfigurationUpdate(
StartEdgeConfigurationUpdateRequest startEdgeConfigurationUpdateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the
* stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at
* your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The
* SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge
* Agent.
*
*
* If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync
* status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state
* such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API
* during the syncing process, a ResourceInUseException will be thrown. The connectivity of the
* stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will
* transition into the SYNC_FAILED state.
*
*
* To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the
* current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.
*
*
*
* This is a convenience which creates an instance of the {@link StartEdgeConfigurationUpdateRequest.Builder}
* avoiding the need to create one manually via {@link StartEdgeConfigurationUpdateRequest#builder()}
*
*
* @param startEdgeConfigurationUpdateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.StartEdgeConfigurationUpdateRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the StartEdgeConfigurationUpdate operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - NoDataRetentionException The Stream data retention in hours is equal to zero.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.StartEdgeConfigurationUpdate
* @see AWS API Documentation
*/
default CompletableFuture startEdgeConfigurationUpdate(
Consumer startEdgeConfigurationUpdateRequest) {
return startEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest.builder()
.applyMutation(startEdgeConfigurationUpdateRequest).build());
}
/**
*
* Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you
* can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value
* is replaced with the value that you specify in the request. For more information, see Using Cost Allocation
* Tags in the Billing and Cost Management and Cost Management User Guide.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - TagsPerResourceExceededLimitException You have exceeded the limit of tags that you can associate with
* the resource. A Kinesis video stream can support up to 50 tags.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you
* can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value
* is replaced with the value that you specify in the request. For more information, see Using Cost Allocation
* Tags in the Billing and Cost Management and Cost Management User Guide.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.TagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - TagsPerResourceExceededLimitException You have exceeded the limit of tags that you can associate with
* the resource. A Kinesis video stream can support up to 50 tags.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define
* and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced
* with the value that you specify in the request. For more information, see Using Cost Allocation
* Tags in the Billing and Cost Management and Cost Management User Guide.
*
*
* You must provide either the StreamName or the StreamARN.
*
*
* This operation requires permission for the KinesisVideo:TagStream action.
*
*
* A Kinesis video stream can support up to 50 tags.
*
*
* @param tagStreamRequest
* @return A Java Future containing the result of the TagStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - InvalidResourceFormatException The format of the
StreamARN is invalid.
* - TagsPerResourceExceededLimitException You have exceeded the limit of tags that you can associate with
* the resource. A Kinesis video stream can support up to 50 tags.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.TagStream
* @see AWS API
* Documentation
*/
default CompletableFuture tagStream(TagStreamRequest tagStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define
* and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced
* with the value that you specify in the request. For more information, see Using Cost Allocation
* Tags in the Billing and Cost Management and Cost Management User Guide.
*
*
* You must provide either the StreamName or the StreamARN.
*
*
* This operation requires permission for the KinesisVideo:TagStream action.
*
*
* A Kinesis video stream can support up to 50 tags.
*
*
*
* This is a convenience which creates an instance of the {@link TagStreamRequest.Builder} avoiding the need to
* create one manually via {@link TagStreamRequest#builder()}
*
*
* @param tagStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.TagStreamRequest.Builder} to create a request.
* @return A Java Future containing the result of the TagStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - InvalidResourceFormatException The format of the
StreamARN is invalid.
* - TagsPerResourceExceededLimitException You have exceeded the limit of tags that you can associate with
* the resource. A Kinesis video stream can support up to 50 tags.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.TagStream
* @see AWS API
* Documentation
*/
default CompletableFuture tagStream(Consumer tagStreamRequest) {
return tagStream(TagStreamRequest.builder().applyMutation(tagStreamRequest).build());
}
/**
*
* Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify
* the value. If you specify a tag key that does not exist, it's ignored.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UntagResource
* @see AWS
* API Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify
* the value. If you specify a tag key that does not exist, it's ignored.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.UntagResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UntagResource
* @see AWS
* API Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value.
* If you specify a tag key that does not exist, it's ignored.
*
*
* In the request, you must provide the StreamName or StreamARN.
*
*
* @param untagStreamRequest
* @return A Java Future containing the result of the UntagStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - InvalidResourceFormatException The format of the
StreamARN is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UntagStream
* @see AWS API
* Documentation
*/
default CompletableFuture untagStream(UntagStreamRequest untagStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value.
* If you specify a tag key that does not exist, it's ignored.
*
*
* In the request, you must provide the StreamName or StreamARN.
*
*
*
* This is a convenience which creates an instance of the {@link UntagStreamRequest.Builder} avoiding the need to
* create one manually via {@link UntagStreamRequest#builder()}
*
*
* @param untagStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.UntagStreamRequest.Builder} to create a request.
* @return A Java Future containing the result of the UntagStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - InvalidResourceFormatException The format of the
StreamARN is invalid.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UntagStream
* @see AWS API
* Documentation
*/
default CompletableFuture untagStream(Consumer untagStreamRequest) {
return untagStream(UntagStreamRequest.builder().applyMutation(untagStreamRequest).build());
}
/**
*
* Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you
* want to increase or decrease the data retention period, specify the Operation parameter in the
* request body. In the request, you must specify either the StreamName or the StreamARN.
*
*
* This operation requires permission for the KinesisVideo:UpdateDataRetention action.
*
*
* Changing the data retention period affects the data in the stream as follows:
*
*
* -
*
* If the data retention period is increased, existing data is retained for the new retention period. For example,
* if the data retention period is increased from one hour to seven hours, all existing data is retained for seven
* hours.
*
*
* -
*
* If the data retention period is decreased, existing data is retained for the new retention period. For example,
* if the data retention period is decreased from seven hours to one hour, all existing data is retained for one
* hour, and any data older than one hour is deleted immediately.
*
*
*
*
* @param updateDataRetentionRequest
* @return A Java Future containing the result of the UpdateDataRetention operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - VersionMismatchException The stream version that you specified is not the latest version. To get the
* latest version, use the DescribeStream API.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateDataRetention
* @see AWS API Documentation
*/
default CompletableFuture updateDataRetention(
UpdateDataRetentionRequest updateDataRetentionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you
* want to increase or decrease the data retention period, specify the Operation parameter in the
* request body. In the request, you must specify either the StreamName or the StreamARN.
*
*
* This operation requires permission for the KinesisVideo:UpdateDataRetention action.
*
*
* Changing the data retention period affects the data in the stream as follows:
*
*
* -
*
* If the data retention period is increased, existing data is retained for the new retention period. For example,
* if the data retention period is increased from one hour to seven hours, all existing data is retained for seven
* hours.
*
*
* -
*
* If the data retention period is decreased, existing data is retained for the new retention period. For example,
* if the data retention period is decreased from seven hours to one hour, all existing data is retained for one
* hour, and any data older than one hour is deleted immediately.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDataRetentionRequest.Builder} avoiding the
* need to create one manually via {@link UpdateDataRetentionRequest#builder()}
*
*
* @param updateDataRetentionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.UpdateDataRetentionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateDataRetention operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - VersionMismatchException The stream version that you specified is not the latest version. To get the
* latest version, use the DescribeStream API.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateDataRetention
* @see AWS API Documentation
*/
default CompletableFuture updateDataRetention(
Consumer updateDataRetentionRequest) {
return updateDataRetention(UpdateDataRetentionRequest.builder().applyMutation(updateDataRetentionRequest).build());
}
/**
*
* Updates the StreamInfo and ImageProcessingConfiguration fields.
*
*
* @param updateImageGenerationConfigurationRequest
* @return A Java Future containing the result of the UpdateImageGenerationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - NoDataRetentionException The Stream data retention in hours is equal to zero.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateImageGenerationConfiguration
* @see AWS API Documentation
*/
default CompletableFuture updateImageGenerationConfiguration(
UpdateImageGenerationConfigurationRequest updateImageGenerationConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the StreamInfo and ImageProcessingConfiguration fields.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateImageGenerationConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link UpdateImageGenerationConfigurationRequest#builder()}
*
*
* @param updateImageGenerationConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.UpdateImageGenerationConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the UpdateImageGenerationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - NoDataRetentionException The Stream data retention in hours is equal to zero.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateImageGenerationConfiguration
* @see AWS API Documentation
*/
default CompletableFuture updateImageGenerationConfiguration(
Consumer updateImageGenerationConfigurationRequest) {
return updateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest.builder()
.applyMutation(updateImageGenerationConfigurationRequest).build());
}
/**
*
* Associates a SignalingChannel to a stream to store the media. There are two signaling modes that you
* can specify :
*
*
* -
*
* If StorageStatus is enabled, the data will be stored in the StreamARN provided. In
* order for WebRTC Ingestion to work, the stream must have data retention enabled.
*
*
* -
*
* If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will
* not be needed.
*
*
*
*
*
* If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers
* connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP
* offer send and establish a connection between a peer and the storage session.
*
*
*
* @param updateMediaStorageConfigurationRequest
* @return A Java Future containing the result of the UpdateMediaStorageConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - NoDataRetentionException The Stream data retention in hours is equal to zero.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateMediaStorageConfiguration
* @see AWS API Documentation
*/
default CompletableFuture updateMediaStorageConfiguration(
UpdateMediaStorageConfigurationRequest updateMediaStorageConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Associates a SignalingChannel to a stream to store the media. There are two signaling modes that you
* can specify :
*
*
* -
*
* If StorageStatus is enabled, the data will be stored in the StreamARN provided. In
* order for WebRTC Ingestion to work, the stream must have data retention enabled.
*
*
* -
*
* If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will
* not be needed.
*
*
*
*
*
* If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers
* connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP
* offer send and establish a connection between a peer and the storage session.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateMediaStorageConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link UpdateMediaStorageConfigurationRequest#builder()}
*
*
* @param updateMediaStorageConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.UpdateMediaStorageConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the UpdateMediaStorageConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - NoDataRetentionException The Stream data retention in hours is equal to zero.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateMediaStorageConfiguration
* @see AWS API Documentation
*/
default CompletableFuture updateMediaStorageConfiguration(
Consumer updateMediaStorageConfigurationRequest) {
return updateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest.builder()
.applyMutation(updateMediaStorageConfigurationRequest).build());
}
/**
*
* Updates the notification information for a stream.
*
*
* @param updateNotificationConfigurationRequest
* @return A Java Future containing the result of the UpdateNotificationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - NoDataRetentionException The Stream data retention in hours is equal to zero.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateNotificationConfiguration
* @see AWS API Documentation
*/
default CompletableFuture updateNotificationConfiguration(
UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the notification information for a stream.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateNotificationConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link UpdateNotificationConfigurationRequest#builder()}
*
*
* @param updateNotificationConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.UpdateNotificationConfigurationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the UpdateNotificationConfiguration operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - AccessDeniedException You do not have required permissions to perform this operation.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - NoDataRetentionException The Stream data retention in hours is equal to zero.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateNotificationConfiguration
* @see AWS API Documentation
*/
default CompletableFuture updateNotificationConfiguration(
Consumer updateNotificationConfigurationRequest) {
return updateNotificationConfiguration(UpdateNotificationConfigurationRequest.builder()
.applyMutation(updateNotificationConfigurationRequest).build());
}
/**
*
* Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
*
*
* If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new
* messages sent via this channel after it's been updated. Existing messages are still expired as per the previous
* MessageTtlSeconds value.
*
*
* @param updateSignalingChannelRequest
* @return A Java Future containing the result of the UpdateSignalingChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - VersionMismatchException The stream version that you specified is not the latest version. To get the
* latest version, use the DescribeStream API.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateSignalingChannel
* @see AWS API Documentation
*/
default CompletableFuture updateSignalingChannel(
UpdateSignalingChannelRequest updateSignalingChannelRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
*
*
* If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new
* messages sent via this channel after it's been updated. Existing messages are still expired as per the previous
* MessageTtlSeconds value.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateSignalingChannelRequest.Builder} avoiding the
* need to create one manually via {@link UpdateSignalingChannelRequest#builder()}
*
*
* @param updateSignalingChannelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.UpdateSignalingChannelRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the UpdateSignalingChannel operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidArgumentException The value for this input parameter is invalid.
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - AccessDeniedException You do not have required permissions to perform this operation.
* - VersionMismatchException The stream version that you specified is not the latest version. To get the
* latest version, use the DescribeStream API.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateSignalingChannel
* @see AWS API Documentation
*/
default CompletableFuture updateSignalingChannel(
Consumer updateSignalingChannelRequest) {
return updateSignalingChannel(UpdateSignalingChannelRequest.builder().applyMutation(updateSignalingChannelRequest)
.build());
}
/**
*
* Updates stream metadata, such as the device name and media type.
*
*
* You must provide the stream name or the Amazon Resource Name (ARN) of the stream.
*
*
* To make sure that you have the latest version of the stream before updating it, you can specify the stream
* version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams
* assigns a new version number. To get the latest stream version, use the DescribeStream API.
*
*
* UpdateStream is an asynchronous operation, and takes time to complete.
*
*
* @param updateStreamRequest
* @return A Java Future containing the result of the UpdateStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - VersionMismatchException The stream version that you specified is not the latest version. To get the
* latest version, use the DescribeStream API.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateStream
* @see AWS API
* Documentation
*/
default CompletableFuture updateStream(UpdateStreamRequest updateStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates stream metadata, such as the device name and media type.
*
*
* You must provide the stream name or the Amazon Resource Name (ARN) of the stream.
*
*
* To make sure that you have the latest version of the stream before updating it, you can specify the stream
* version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams
* assigns a new version number. To get the latest stream version, use the DescribeStream API.
*
*
* UpdateStream is an asynchronous operation, and takes time to complete.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateStreamRequest.Builder} avoiding the need to
* create one manually via {@link UpdateStreamRequest#builder()}
*
*
* @param updateStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.kinesisvideo.model.UpdateStreamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ClientLimitExceededException Kinesis Video Streams has throttled the request because you have
* exceeded the limit of allowed client calls. Try making the call later.
* - InvalidArgumentException The value for this input parameter is invalid.
* - ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
* - ResourceInUseException When the input
StreamARN or ChannelARN in
* CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the
* provided input StreamARN or ChannelARN is not in Active status, try one of the
* following :
*
* -
*
* The DescribeMediaStorageConfiguration API to determine what the stream given channel is
* mapped to.
*
*
* -
*
* The DescribeMappedResourceConfiguration API to determine the channel that the given stream
* is mapped to.
*
*
* -
*
* The DescribeStream or DescribeSignalingChannel API to determine the status of
* the resource.
*
*
* - NotAuthorizedException The caller is not authorized to perform this operation.
* - VersionMismatchException The stream version that you specified is not the latest version. To get the
* latest version, use the DescribeStream API.
* - 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.
* - KinesisVideoException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample KinesisVideoAsyncClient.UpdateStream
* @see AWS API
* Documentation
*/
default CompletableFuture updateStream(Consumer updateStreamRequest) {
return updateStream(UpdateStreamRequest.builder().applyMutation(updateStreamRequest).build());
}
@Override
default KinesisVideoServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link KinesisVideoAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static KinesisVideoAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link KinesisVideoAsyncClient}.
*/
static KinesisVideoAsyncClientBuilder builder() {
return new DefaultKinesisVideoAsyncClientBuilder();
}
}