/* * Copyright 2018-2023 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 com.amazonaws.services.kinesisvideo; import javax.annotation.Generated; import com.amazonaws.services.kinesisvideo.model.*; /** * Interface for accessing Kinesis Video asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.kinesisvideo.AbstractAmazonKinesisVideoAsync} instead. *

*

*

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonKinesisVideoAsync extends AmazonKinesisVideo { /** *

* 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. * @sample AmazonKinesisVideoAsync.CreateSignalingChannel * @see AWS API Documentation */ java.util.concurrent.Future createSignalingChannelAsync(CreateSignalingChannelRequest createSignalingChannelRequest); /** *

* Creates a signaling channel. *

*

* CreateSignalingChannel is an asynchronous operation. *

* * @param createSignalingChannelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateSignalingChannel operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.CreateSignalingChannel * @see AWS API Documentation */ java.util.concurrent.Future createSignalingChannelAsync(CreateSignalingChannelRequest createSignalingChannelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.CreateStream * @see AWS API * Documentation */ java.util.concurrent.Future createStreamAsync(CreateStreamRequest createStreamRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateStream operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.CreateStream * @see AWS API * Documentation */ java.util.concurrent.Future createStreamAsync(CreateStreamRequest createStreamRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.DeleteEdgeConfiguration * @see AWS API Documentation */ java.util.concurrent.Future deleteEdgeConfigurationAsync(DeleteEdgeConfigurationRequest deleteEdgeConfigurationRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteEdgeConfiguration operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.DeleteEdgeConfiguration * @see AWS API Documentation */ java.util.concurrent.Future deleteEdgeConfigurationAsync(DeleteEdgeConfigurationRequest deleteEdgeConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.DeleteSignalingChannel * @see AWS API Documentation */ java.util.concurrent.Future deleteSignalingChannelAsync(DeleteSignalingChannelRequest deleteSignalingChannelRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteSignalingChannel operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.DeleteSignalingChannel * @see AWS API Documentation */ java.util.concurrent.Future deleteSignalingChannelAsync(DeleteSignalingChannelRequest deleteSignalingChannelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.DeleteStream * @see AWS API * Documentation */ java.util.concurrent.Future deleteStreamAsync(DeleteStreamRequest deleteStreamRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteStream operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.DeleteStream * @see AWS API * Documentation */ java.util.concurrent.Future deleteStreamAsync(DeleteStreamRequest deleteStreamRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.DescribeEdgeConfiguration * @see AWS API Documentation */ java.util.concurrent.Future describeEdgeConfigurationAsync( DescribeEdgeConfigurationRequest describeEdgeConfigurationRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeEdgeConfiguration operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.DescribeEdgeConfiguration * @see AWS API Documentation */ java.util.concurrent.Future describeEdgeConfigurationAsync( DescribeEdgeConfigurationRequest describeEdgeConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.DescribeImageGenerationConfiguration * @see AWS API Documentation */ java.util.concurrent.Future describeImageGenerationConfigurationAsync( DescribeImageGenerationConfigurationRequest describeImageGenerationConfigurationRequest); /** *

* Gets the ImageGenerationConfiguration for a given Kinesis video stream. *

* * @param describeImageGenerationConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeImageGenerationConfiguration operation returned by the * service. * @sample AmazonKinesisVideoAsyncHandler.DescribeImageGenerationConfiguration * @see AWS API Documentation */ java.util.concurrent.Future describeImageGenerationConfigurationAsync( DescribeImageGenerationConfigurationRequest describeImageGenerationConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.DescribeMappedResourceConfiguration * @see AWS API Documentation */ java.util.concurrent.Future describeMappedResourceConfigurationAsync( DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest); /** *

* Returns the most current information about the stream. The streamName or streamARN * should be provided in the input. *

* * @param describeMappedResourceConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeMappedResourceConfiguration operation returned by the * service. * @sample AmazonKinesisVideoAsyncHandler.DescribeMappedResourceConfiguration * @see AWS API Documentation */ java.util.concurrent.Future describeMappedResourceConfigurationAsync( DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.DescribeMediaStorageConfiguration * @see AWS API Documentation */ java.util.concurrent.Future describeMediaStorageConfigurationAsync( DescribeMediaStorageConfigurationRequest describeMediaStorageConfigurationRequest); /** *

* Returns the most current information about the channel. Specify the ChannelName or * ChannelARN in the input. *

* * @param describeMediaStorageConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeMediaStorageConfiguration operation returned by the * service. * @sample AmazonKinesisVideoAsyncHandler.DescribeMediaStorageConfiguration * @see AWS API Documentation */ java.util.concurrent.Future describeMediaStorageConfigurationAsync( DescribeMediaStorageConfigurationRequest describeMediaStorageConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.DescribeNotificationConfiguration * @see AWS API Documentation */ java.util.concurrent.Future describeNotificationConfigurationAsync( DescribeNotificationConfigurationRequest describeNotificationConfigurationRequest); /** *

* Gets the NotificationConfiguration for a given Kinesis video stream. *

* * @param describeNotificationConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeNotificationConfiguration operation returned by the * service. * @sample AmazonKinesisVideoAsyncHandler.DescribeNotificationConfiguration * @see AWS API Documentation */ java.util.concurrent.Future describeNotificationConfigurationAsync( DescribeNotificationConfigurationRequest describeNotificationConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.DescribeSignalingChannel * @see AWS API Documentation */ java.util.concurrent.Future describeSignalingChannelAsync(DescribeSignalingChannelRequest describeSignalingChannelRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeSignalingChannel operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.DescribeSignalingChannel * @see AWS API Documentation */ java.util.concurrent.Future describeSignalingChannelAsync(DescribeSignalingChannelRequest describeSignalingChannelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.DescribeStream * @see AWS * API Documentation */ java.util.concurrent.Future describeStreamAsync(DescribeStreamRequest describeStreamRequest); /** *

* Returns the most current information about the specified stream. You must specify either the * StreamName or the StreamARN. *

* * @param describeStreamRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeStream operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.DescribeStream * @see AWS * API Documentation */ java.util.concurrent.Future describeStreamAsync(DescribeStreamRequest describeStreamRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.GetDataEndpoint * @see AWS * API Documentation */ java.util.concurrent.Future getDataEndpointAsync(GetDataEndpointRequest getDataEndpointRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetDataEndpoint operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.GetDataEndpoint * @see AWS * API Documentation */ java.util.concurrent.Future getDataEndpointAsync(GetDataEndpointRequest getDataEndpointRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.GetSignalingChannelEndpoint * @see AWS API Documentation */ java.util.concurrent.Future getSignalingChannelEndpointAsync( GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetSignalingChannelEndpoint operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.GetSignalingChannelEndpoint * @see AWS API Documentation */ java.util.concurrent.Future getSignalingChannelEndpointAsync( GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.ListEdgeAgentConfigurations * @see AWS API Documentation */ java.util.concurrent.Future listEdgeAgentConfigurationsAsync( ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest); /** *

* Returns an array of edge configurations associated with the specified Edge Agent. *

*

* In the request, you must specify the Edge Agent HubDeviceArn. *

* * @param listEdgeAgentConfigurationsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListEdgeAgentConfigurations operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.ListEdgeAgentConfigurations * @see AWS API Documentation */ java.util.concurrent.Future listEdgeAgentConfigurationsAsync( ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.ListSignalingChannels * @see AWS API Documentation */ java.util.concurrent.Future listSignalingChannelsAsync(ListSignalingChannelsRequest listSignalingChannelsRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSignalingChannels operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.ListSignalingChannels * @see AWS API Documentation */ java.util.concurrent.Future listSignalingChannelsAsync(ListSignalingChannelsRequest listSignalingChannelsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.ListStreams * @see AWS API * Documentation */ java.util.concurrent.Future listStreamsAsync(ListStreamsRequest listStreamsRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListStreams operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.ListStreams * @see AWS API * Documentation */ java.util.concurrent.Future listStreamsAsync(ListStreamsRequest listStreamsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Returns a list of tags associated with the specified signaling channel. *

* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.ListTagsForStream * @see AWS * API Documentation */ java.util.concurrent.Future listTagsForStreamAsync(ListTagsForStreamRequest listTagsForStreamRequest); /** *

* Returns a list of tags associated with the specified stream. *

*

* In the request, you must specify either the StreamName or the StreamARN. *

* * @param listTagsForStreamRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForStream operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.ListTagsForStream * @see AWS * API Documentation */ java.util.concurrent.Future listTagsForStreamAsync(ListTagsForStreamRequest listTagsForStreamRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param startEdgeConfigurationUpdateRequest * @return A Java Future containing the result of the StartEdgeConfigurationUpdate operation returned by the * service. * @sample AmazonKinesisVideoAsync.StartEdgeConfigurationUpdate * @see AWS API Documentation */ java.util.concurrent.Future startEdgeConfigurationUpdateAsync( StartEdgeConfigurationUpdateRequest startEdgeConfigurationUpdateRequest); /** *

* 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. *

* * @param startEdgeConfigurationUpdateRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartEdgeConfigurationUpdate operation returned by the * service. * @sample AmazonKinesisVideoAsyncHandler.StartEdgeConfigurationUpdate * @see AWS API Documentation */ java.util.concurrent.Future startEdgeConfigurationUpdateAsync( StartEdgeConfigurationUpdateRequest startEdgeConfigurationUpdateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.TagStream * @see AWS API * Documentation */ java.util.concurrent.Future tagStreamAsync(TagStreamRequest tagStreamRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagStream operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.TagStream * @see AWS API * Documentation */ java.util.concurrent.Future tagStreamAsync(TagStreamRequest tagStreamRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.UntagStream * @see AWS API * Documentation */ java.util.concurrent.Future untagStreamAsync(UntagStreamRequest untagStreamRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagStream operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.UntagStream * @see AWS API * Documentation */ java.util.concurrent.Future untagStreamAsync(UntagStreamRequest untagStreamRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* *

* The retention period that you specify replaces the current value. *

*
*

* 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. * @sample AmazonKinesisVideoAsync.UpdateDataRetention * @see AWS API Documentation */ java.util.concurrent.Future updateDataRetentionAsync(UpdateDataRetentionRequest updateDataRetentionRequest); /** *

* 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. *

* *

* The retention period that you specify replaces the current value. *

*
*

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateDataRetention operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.UpdateDataRetention * @see AWS API Documentation */ java.util.concurrent.Future updateDataRetentionAsync(UpdateDataRetentionRequest updateDataRetentionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Updates the StreamInfo and ImageProcessingConfiguration fields. *

* * @param updateImageGenerationConfigurationRequest * @return A Java Future containing the result of the UpdateImageGenerationConfiguration operation returned by the * service. * @sample AmazonKinesisVideoAsync.UpdateImageGenerationConfiguration * @see AWS API Documentation */ java.util.concurrent.Future updateImageGenerationConfigurationAsync( UpdateImageGenerationConfigurationRequest updateImageGenerationConfigurationRequest); /** *

* Updates the StreamInfo and ImageProcessingConfiguration fields. *

* * @param updateImageGenerationConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateImageGenerationConfiguration operation returned by the * service. * @sample AmazonKinesisVideoAsyncHandler.UpdateImageGenerationConfiguration * @see AWS API Documentation */ java.util.concurrent.Future updateImageGenerationConfigurationAsync( UpdateImageGenerationConfigurationRequest updateImageGenerationConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can * specified : *

*
    *
  • *

    * If the StorageStatus is disabled, no data will be stored, and the StreamARN parameter * will not be needed. *

    *
  • *
  • *

    * If the StorageStatus is enabled, the data will be stored in the StreamARN provided. *

    *
  • *
* * @param updateMediaStorageConfigurationRequest * @return A Java Future containing the result of the UpdateMediaStorageConfiguration operation returned by the * service. * @sample AmazonKinesisVideoAsync.UpdateMediaStorageConfiguration * @see AWS API Documentation */ java.util.concurrent.Future updateMediaStorageConfigurationAsync( UpdateMediaStorageConfigurationRequest updateMediaStorageConfigurationRequest); /** *

* Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can * specified : *

*
    *
  • *

    * If the StorageStatus is disabled, no data will be stored, and the StreamARN parameter * will not be needed. *

    *
  • *
  • *

    * If the StorageStatus is enabled, the data will be stored in the StreamARN provided. *

    *
  • *
* * @param updateMediaStorageConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateMediaStorageConfiguration operation returned by the * service. * @sample AmazonKinesisVideoAsyncHandler.UpdateMediaStorageConfiguration * @see AWS API Documentation */ java.util.concurrent.Future updateMediaStorageConfigurationAsync( UpdateMediaStorageConfigurationRequest updateMediaStorageConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Updates the notification information for a stream. *

* * @param updateNotificationConfigurationRequest * @return A Java Future containing the result of the UpdateNotificationConfiguration operation returned by the * service. * @sample AmazonKinesisVideoAsync.UpdateNotificationConfiguration * @see AWS API Documentation */ java.util.concurrent.Future updateNotificationConfigurationAsync( UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest); /** *

* Updates the notification information for a stream. *

* * @param updateNotificationConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateNotificationConfiguration operation returned by the * service. * @sample AmazonKinesisVideoAsyncHandler.UpdateNotificationConfiguration * @see AWS API Documentation */ java.util.concurrent.Future updateNotificationConfigurationAsync( UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.UpdateSignalingChannel * @see AWS API Documentation */ java.util.concurrent.Future updateSignalingChannelAsync(UpdateSignalingChannelRequest updateSignalingChannelRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateSignalingChannel operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.UpdateSignalingChannel * @see AWS API Documentation */ java.util.concurrent.Future updateSignalingChannelAsync(UpdateSignalingChannelRequest updateSignalingChannelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. * @sample AmazonKinesisVideoAsync.UpdateStream * @see AWS API * Documentation */ java.util.concurrent.Future updateStreamAsync(UpdateStreamRequest updateStreamRequest); /** *

* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateStream operation returned by the service. * @sample AmazonKinesisVideoAsyncHandler.UpdateStream * @see AWS API * Documentation */ java.util.concurrent.Future updateStreamAsync(UpdateStreamRequest updateStreamRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }