/*
* 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.
*/
/*
* Do not modify this file. This file is generated from the kinesisvideo-2017-09-30.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.KinesisVideo.Model;
namespace Amazon.KinesisVideo
{
///
/// Interface for accessing KinesisVideo
///
///
///
public partial interface IAmazonKinesisVideo : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IKinesisVideoPaginatorFactory Paginators { get; }
#endif
#region CreateSignalingChannel
///
/// Creates a signaling channel.
///
///
///
/// CreateSignalingChannel
is an asynchronous operation.
///
///
/// Container for the necessary parameters to execute the CreateSignalingChannel service method.
///
/// The response from the CreateSignalingChannel service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// You have reached the maximum limit of active signaling channels for this Amazon Web
/// Services account in this region.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// 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.
///
///
///
///
/// You have exceeded the limit of tags that you can associate with the resource. A Kinesis
/// video stream can support up to 50 tags.
///
/// REST API Reference for CreateSignalingChannel Operation
CreateSignalingChannelResponse CreateSignalingChannel(CreateSignalingChannelRequest request);
///
/// Initiates the asynchronous execution of the CreateSignalingChannel operation.
///
///
/// Container for the necessary parameters to execute the CreateSignalingChannel operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSignalingChannel
/// operation.
/// REST API Reference for CreateSignalingChannel Operation
IAsyncResult BeginCreateSignalingChannel(CreateSignalingChannelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateSignalingChannel operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateSignalingChannel.
///
/// Returns a CreateSignalingChannelResult from KinesisVideo.
/// REST API Reference for CreateSignalingChannel Operation
CreateSignalingChannelResponse EndCreateSignalingChannel(IAsyncResult asyncResult);
#endregion
#region CreateStream
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateStream service method.
///
/// The response from the CreateStream service method, as returned by KinesisVideo.
///
/// The number of streams created for the account is too high.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// Not implemented.
///
///
/// The value for this input parameter is invalid.
///
///
/// Not implemented.
///
///
/// 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.
///
///
///
///
/// You have exceeded the limit of tags that you can associate with the resource. A Kinesis
/// video stream can support up to 50 tags.
///
/// REST API Reference for CreateStream Operation
CreateStreamResponse CreateStream(CreateStreamRequest request);
///
/// Initiates the asynchronous execution of the CreateStream operation.
///
///
/// Container for the necessary parameters to execute the CreateStream operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStream
/// operation.
/// REST API Reference for CreateStream Operation
IAsyncResult BeginCreateStream(CreateStreamRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateStream operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateStream.
///
/// Returns a CreateStreamResult from KinesisVideo.
/// REST API Reference for CreateStream Operation
CreateStreamResponse EndCreateStream(IAsyncResult asyncResult);
#endregion
#region DeleteEdgeConfiguration
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DeleteEdgeConfiguration service method.
///
/// The response from the DeleteEdgeConfiguration service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
///
/// The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's
/// edge configuration that you specified.
///
/// REST API Reference for DeleteEdgeConfiguration Operation
DeleteEdgeConfigurationResponse DeleteEdgeConfiguration(DeleteEdgeConfigurationRequest request);
///
/// Initiates the asynchronous execution of the DeleteEdgeConfiguration operation.
///
///
/// Container for the necessary parameters to execute the DeleteEdgeConfiguration operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteEdgeConfiguration
/// operation.
/// REST API Reference for DeleteEdgeConfiguration Operation
IAsyncResult BeginDeleteEdgeConfiguration(DeleteEdgeConfigurationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteEdgeConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteEdgeConfiguration.
///
/// Returns a DeleteEdgeConfigurationResult from KinesisVideo.
/// REST API Reference for DeleteEdgeConfiguration Operation
DeleteEdgeConfigurationResponse EndDeleteEdgeConfiguration(IAsyncResult asyncResult);
#endregion
#region DeleteSignalingChannel
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteSignalingChannel service method.
///
/// The response from the DeleteSignalingChannel service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// 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.
///
///
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
///
/// The stream version that you specified is not the latest version. To get the latest
/// version, use the DescribeStream
/// API.
///
/// REST API Reference for DeleteSignalingChannel Operation
DeleteSignalingChannelResponse DeleteSignalingChannel(DeleteSignalingChannelRequest request);
///
/// Initiates the asynchronous execution of the DeleteSignalingChannel operation.
///
///
/// Container for the necessary parameters to execute the DeleteSignalingChannel operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSignalingChannel
/// operation.
/// REST API Reference for DeleteSignalingChannel Operation
IAsyncResult BeginDeleteSignalingChannel(DeleteSignalingChannelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteSignalingChannel operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteSignalingChannel.
///
/// Returns a DeleteSignalingChannelResult from KinesisVideo.
/// REST API Reference for DeleteSignalingChannel Operation
DeleteSignalingChannelResponse EndDeleteSignalingChannel(IAsyncResult asyncResult);
#endregion
#region DeleteStream
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DeleteStream service method.
///
/// The response from the DeleteStream service method, as returned by KinesisVideo.
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The caller is not authorized to perform this operation.
///
///
/// 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.
///
///
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
///
/// The stream version that you specified is not the latest version. To get the latest
/// version, use the DescribeStream
/// API.
///
/// REST API Reference for DeleteStream Operation
DeleteStreamResponse DeleteStream(DeleteStreamRequest request);
///
/// Initiates the asynchronous execution of the DeleteStream operation.
///
///
/// Container for the necessary parameters to execute the DeleteStream operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteStream
/// operation.
/// REST API Reference for DeleteStream Operation
IAsyncResult BeginDeleteStream(DeleteStreamRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteStream operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteStream.
///
/// Returns a DeleteStreamResult from KinesisVideo.
/// REST API Reference for DeleteStream Operation
DeleteStreamResponse EndDeleteStream(IAsyncResult asyncResult);
#endregion
#region DescribeEdgeConfiguration
///
/// 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.
///
/// Container for the necessary parameters to execute the DescribeEdgeConfiguration service method.
///
/// The response from the DescribeEdgeConfiguration service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
///
/// The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's
/// edge configuration that you specified.
///
/// REST API Reference for DescribeEdgeConfiguration Operation
DescribeEdgeConfigurationResponse DescribeEdgeConfiguration(DescribeEdgeConfigurationRequest request);
///
/// Initiates the asynchronous execution of the DescribeEdgeConfiguration operation.
///
///
/// Container for the necessary parameters to execute the DescribeEdgeConfiguration operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEdgeConfiguration
/// operation.
/// REST API Reference for DescribeEdgeConfiguration Operation
IAsyncResult BeginDescribeEdgeConfiguration(DescribeEdgeConfigurationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeEdgeConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeEdgeConfiguration.
///
/// Returns a DescribeEdgeConfigurationResult from KinesisVideo.
/// REST API Reference for DescribeEdgeConfiguration Operation
DescribeEdgeConfigurationResponse EndDescribeEdgeConfiguration(IAsyncResult asyncResult);
#endregion
#region DescribeImageGenerationConfiguration
///
/// Gets the ImageGenerationConfiguration
for a given Kinesis video stream.
///
/// Container for the necessary parameters to execute the DescribeImageGenerationConfiguration service method.
///
/// The response from the DescribeImageGenerationConfiguration service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for DescribeImageGenerationConfiguration Operation
DescribeImageGenerationConfigurationResponse DescribeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest request);
///
/// Initiates the asynchronous execution of the DescribeImageGenerationConfiguration operation.
///
///
/// Container for the necessary parameters to execute the DescribeImageGenerationConfiguration operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeImageGenerationConfiguration
/// operation.
/// REST API Reference for DescribeImageGenerationConfiguration Operation
IAsyncResult BeginDescribeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeImageGenerationConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeImageGenerationConfiguration.
///
/// Returns a DescribeImageGenerationConfigurationResult from KinesisVideo.
/// REST API Reference for DescribeImageGenerationConfiguration Operation
DescribeImageGenerationConfigurationResponse EndDescribeImageGenerationConfiguration(IAsyncResult asyncResult);
#endregion
#region DescribeMappedResourceConfiguration
///
/// Returns the most current information about the stream. The streamName
/// or streamARN
should be provided in the input.
///
/// Container for the necessary parameters to execute the DescribeMappedResourceConfiguration service method.
///
/// The response from the DescribeMappedResourceConfiguration service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for DescribeMappedResourceConfiguration Operation
DescribeMappedResourceConfigurationResponse DescribeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest request);
///
/// Initiates the asynchronous execution of the DescribeMappedResourceConfiguration operation.
///
///
/// Container for the necessary parameters to execute the DescribeMappedResourceConfiguration operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeMappedResourceConfiguration
/// operation.
/// REST API Reference for DescribeMappedResourceConfiguration Operation
IAsyncResult BeginDescribeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeMappedResourceConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeMappedResourceConfiguration.
///
/// Returns a DescribeMappedResourceConfigurationResult from KinesisVideo.
/// REST API Reference for DescribeMappedResourceConfiguration Operation
DescribeMappedResourceConfigurationResponse EndDescribeMappedResourceConfiguration(IAsyncResult asyncResult);
#endregion
#region DescribeMediaStorageConfiguration
///
/// Returns the most current information about the channel. Specify the ChannelName
/// or ChannelARN
in the input.
///
/// Container for the necessary parameters to execute the DescribeMediaStorageConfiguration service method.
///
/// The response from the DescribeMediaStorageConfiguration service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for DescribeMediaStorageConfiguration Operation
DescribeMediaStorageConfigurationResponse DescribeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest request);
///
/// Initiates the asynchronous execution of the DescribeMediaStorageConfiguration operation.
///
///
/// Container for the necessary parameters to execute the DescribeMediaStorageConfiguration operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeMediaStorageConfiguration
/// operation.
/// REST API Reference for DescribeMediaStorageConfiguration Operation
IAsyncResult BeginDescribeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeMediaStorageConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeMediaStorageConfiguration.
///
/// Returns a DescribeMediaStorageConfigurationResult from KinesisVideo.
/// REST API Reference for DescribeMediaStorageConfiguration Operation
DescribeMediaStorageConfigurationResponse EndDescribeMediaStorageConfiguration(IAsyncResult asyncResult);
#endregion
#region DescribeNotificationConfiguration
///
/// Gets the NotificationConfiguration
for a given Kinesis video stream.
///
/// Container for the necessary parameters to execute the DescribeNotificationConfiguration service method.
///
/// The response from the DescribeNotificationConfiguration service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for DescribeNotificationConfiguration Operation
DescribeNotificationConfigurationResponse DescribeNotificationConfiguration(DescribeNotificationConfigurationRequest request);
///
/// Initiates the asynchronous execution of the DescribeNotificationConfiguration operation.
///
///
/// Container for the necessary parameters to execute the DescribeNotificationConfiguration operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeNotificationConfiguration
/// operation.
/// REST API Reference for DescribeNotificationConfiguration Operation
IAsyncResult BeginDescribeNotificationConfiguration(DescribeNotificationConfigurationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeNotificationConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeNotificationConfiguration.
///
/// Returns a DescribeNotificationConfigurationResult from KinesisVideo.
/// REST API Reference for DescribeNotificationConfiguration Operation
DescribeNotificationConfigurationResponse EndDescribeNotificationConfiguration(IAsyncResult asyncResult);
#endregion
#region DescribeSignalingChannel
///
/// 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.
///
/// Container for the necessary parameters to execute the DescribeSignalingChannel service method.
///
/// The response from the DescribeSignalingChannel service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for DescribeSignalingChannel Operation
DescribeSignalingChannelResponse DescribeSignalingChannel(DescribeSignalingChannelRequest request);
///
/// Initiates the asynchronous execution of the DescribeSignalingChannel operation.
///
///
/// Container for the necessary parameters to execute the DescribeSignalingChannel operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSignalingChannel
/// operation.
/// REST API Reference for DescribeSignalingChannel Operation
IAsyncResult BeginDescribeSignalingChannel(DescribeSignalingChannelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeSignalingChannel operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeSignalingChannel.
///
/// Returns a DescribeSignalingChannelResult from KinesisVideo.
/// REST API Reference for DescribeSignalingChannel Operation
DescribeSignalingChannelResponse EndDescribeSignalingChannel(IAsyncResult asyncResult);
#endregion
#region DescribeStream
///
/// Returns the most current information about the specified stream. You must specify
/// either the StreamName
or the StreamARN
.
///
/// Container for the necessary parameters to execute the DescribeStream service method.
///
/// The response from the DescribeStream service method, as returned by KinesisVideo.
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The caller is not authorized to perform this operation.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for DescribeStream Operation
DescribeStreamResponse DescribeStream(DescribeStreamRequest request);
///
/// Initiates the asynchronous execution of the DescribeStream operation.
///
///
/// Container for the necessary parameters to execute the DescribeStream operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStream
/// operation.
/// REST API Reference for DescribeStream Operation
IAsyncResult BeginDescribeStream(DescribeStreamRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeStream operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeStream.
///
/// Returns a DescribeStreamResult from KinesisVideo.
/// REST API Reference for DescribeStream Operation
DescribeStreamResponse EndDescribeStream(IAsyncResult asyncResult);
#endregion
#region GetDataEndpoint
///
/// 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
.
///
///
/// Container for the necessary parameters to execute the GetDataEndpoint service method.
///
/// The response from the GetDataEndpoint service method, as returned by KinesisVideo.
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The caller is not authorized to perform this operation.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for GetDataEndpoint Operation
GetDataEndpointResponse GetDataEndpoint(GetDataEndpointRequest request);
///
/// Initiates the asynchronous execution of the GetDataEndpoint operation.
///
///
/// Container for the necessary parameters to execute the GetDataEndpoint operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDataEndpoint
/// operation.
/// REST API Reference for GetDataEndpoint Operation
IAsyncResult BeginGetDataEndpoint(GetDataEndpointRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetDataEndpoint operation.
///
///
/// The IAsyncResult returned by the call to BeginGetDataEndpoint.
///
/// Returns a GetDataEndpointResult from KinesisVideo.
/// REST API Reference for GetDataEndpoint Operation
GetDataEndpointResponse EndGetDataEndpoint(IAsyncResult asyncResult);
#endregion
#region GetSignalingChannelEndpoint
///
/// 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
.
///
///
///
/// Container for the necessary parameters to execute the GetSignalingChannelEndpoint service method.
///
/// The response from the GetSignalingChannelEndpoint service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// 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.
///
///
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for GetSignalingChannelEndpoint Operation
GetSignalingChannelEndpointResponse GetSignalingChannelEndpoint(GetSignalingChannelEndpointRequest request);
///
/// Initiates the asynchronous execution of the GetSignalingChannelEndpoint operation.
///
///
/// Container for the necessary parameters to execute the GetSignalingChannelEndpoint operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSignalingChannelEndpoint
/// operation.
/// REST API Reference for GetSignalingChannelEndpoint Operation
IAsyncResult BeginGetSignalingChannelEndpoint(GetSignalingChannelEndpointRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetSignalingChannelEndpoint operation.
///
///
/// The IAsyncResult returned by the call to BeginGetSignalingChannelEndpoint.
///
/// Returns a GetSignalingChannelEndpointResult from KinesisVideo.
/// REST API Reference for GetSignalingChannelEndpoint Operation
GetSignalingChannelEndpointResponse EndGetSignalingChannelEndpoint(IAsyncResult asyncResult);
#endregion
#region ListEdgeAgentConfigurations
///
/// Returns an array of edge configurations associated with the specified Edge Agent.
///
///
///
/// In the request, you must specify the Edge Agent HubDeviceArn
.
///
///
/// Container for the necessary parameters to execute the ListEdgeAgentConfigurations service method.
///
/// The response from the ListEdgeAgentConfigurations service method, as returned by KinesisVideo.
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The caller is not authorized to perform this operation.
///
/// REST API Reference for ListEdgeAgentConfigurations Operation
ListEdgeAgentConfigurationsResponse ListEdgeAgentConfigurations(ListEdgeAgentConfigurationsRequest request);
///
/// Initiates the asynchronous execution of the ListEdgeAgentConfigurations operation.
///
///
/// Container for the necessary parameters to execute the ListEdgeAgentConfigurations operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListEdgeAgentConfigurations
/// operation.
/// REST API Reference for ListEdgeAgentConfigurations Operation
IAsyncResult BeginListEdgeAgentConfigurations(ListEdgeAgentConfigurationsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListEdgeAgentConfigurations operation.
///
///
/// The IAsyncResult returned by the call to BeginListEdgeAgentConfigurations.
///
/// Returns a ListEdgeAgentConfigurationsResult from KinesisVideo.
/// REST API Reference for ListEdgeAgentConfigurations Operation
ListEdgeAgentConfigurationsResponse EndListEdgeAgentConfigurations(IAsyncResult asyncResult);
#endregion
#region ListSignalingChannels
///
/// 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
.
///
/// Container for the necessary parameters to execute the ListSignalingChannels service method.
///
/// The response from the ListSignalingChannels service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
/// REST API Reference for ListSignalingChannels Operation
ListSignalingChannelsResponse ListSignalingChannels(ListSignalingChannelsRequest request);
///
/// Initiates the asynchronous execution of the ListSignalingChannels operation.
///
///
/// Container for the necessary parameters to execute the ListSignalingChannels operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSignalingChannels
/// operation.
/// REST API Reference for ListSignalingChannels Operation
IAsyncResult BeginListSignalingChannels(ListSignalingChannelsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListSignalingChannels operation.
///
///
/// The IAsyncResult returned by the call to BeginListSignalingChannels.
///
/// Returns a ListSignalingChannelsResult from KinesisVideo.
/// REST API Reference for ListSignalingChannels Operation
ListSignalingChannelsResponse EndListSignalingChannels(IAsyncResult asyncResult);
#endregion
#region ListStreams
///
/// 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
.
///
/// Container for the necessary parameters to execute the ListStreams service method.
///
/// The response from the ListStreams service method, as returned by KinesisVideo.
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
/// REST API Reference for ListStreams Operation
ListStreamsResponse ListStreams(ListStreamsRequest request);
///
/// Initiates the asynchronous execution of the ListStreams operation.
///
///
/// Container for the necessary parameters to execute the ListStreams operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStreams
/// operation.
/// REST API Reference for ListStreams Operation
IAsyncResult BeginListStreams(ListStreamsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListStreams operation.
///
///
/// The IAsyncResult returned by the call to BeginListStreams.
///
/// Returns a ListStreamsResult from KinesisVideo.
/// REST API Reference for ListStreams Operation
ListStreamsResponse EndListStreams(IAsyncResult asyncResult);
#endregion
#region ListTagsForResource
///
/// Returns a list of tags associated with the specified signaling channel.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// Initiates the asynchronous execution of the ListTagsForResource operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource
/// operation.
/// REST API Reference for ListTagsForResource Operation
IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTagsForResource operation.
///
///
/// The IAsyncResult returned by the call to BeginListTagsForResource.
///
/// Returns a ListTagsForResourceResult from KinesisVideo.
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult);
#endregion
#region ListTagsForStream
///
/// Returns a list of tags associated with the specified stream.
///
///
///
/// In the request, you must specify either the StreamName
or the StreamARN
.
///
///
///
/// Container for the necessary parameters to execute the ListTagsForStream service method.
///
/// The response from the ListTagsForStream service method, as returned by KinesisVideo.
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The format of the StreamARN
is invalid.
///
///
/// The caller is not authorized to perform this operation.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for ListTagsForStream Operation
ListTagsForStreamResponse ListTagsForStream(ListTagsForStreamRequest request);
///
/// Initiates the asynchronous execution of the ListTagsForStream operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForStream operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForStream
/// operation.
/// REST API Reference for ListTagsForStream Operation
IAsyncResult BeginListTagsForStream(ListTagsForStreamRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTagsForStream operation.
///
///
/// The IAsyncResult returned by the call to BeginListTagsForStream.
///
/// Returns a ListTagsForStreamResult from KinesisVideo.
/// REST API Reference for ListTagsForStream Operation
ListTagsForStreamResponse EndListTagsForStream(IAsyncResult asyncResult);
#endregion
#region StartEdgeConfigurationUpdate
///
/// 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.
///
///
/// Container for the necessary parameters to execute the StartEdgeConfigurationUpdate service method.
///
/// The response from the StartEdgeConfigurationUpdate service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The Stream data retention in hours is equal to zero.
///
///
/// 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.
///
///
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for StartEdgeConfigurationUpdate Operation
StartEdgeConfigurationUpdateResponse StartEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest request);
///
/// Initiates the asynchronous execution of the StartEdgeConfigurationUpdate operation.
///
///
/// Container for the necessary parameters to execute the StartEdgeConfigurationUpdate operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartEdgeConfigurationUpdate
/// operation.
/// REST API Reference for StartEdgeConfigurationUpdate Operation
IAsyncResult BeginStartEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartEdgeConfigurationUpdate operation.
///
///
/// The IAsyncResult returned by the call to BeginStartEdgeConfigurationUpdate.
///
/// Returns a StartEdgeConfigurationUpdateResult from KinesisVideo.
/// REST API Reference for StartEdgeConfigurationUpdate Operation
StartEdgeConfigurationUpdateResponse EndStartEdgeConfigurationUpdate(IAsyncResult asyncResult);
#endregion
#region TagResource
///
/// 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.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
///
/// You have exceeded the limit of tags that you can associate with the resource. A Kinesis
/// video stream can support up to 50 tags.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// Initiates the asynchronous execution of the TagResource operation.
///
///
/// Container for the necessary parameters to execute the TagResource operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource
/// operation.
/// REST API Reference for TagResource Operation
IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the TagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginTagResource.
///
/// Returns a TagResourceResult from KinesisVideo.
/// REST API Reference for TagResource Operation
TagResourceResponse EndTagResource(IAsyncResult asyncResult);
#endregion
#region TagStream
///
/// 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.
///
///
/// Container for the necessary parameters to execute the TagStream service method.
///
/// The response from the TagStream service method, as returned by KinesisVideo.
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The format of the StreamARN
is invalid.
///
///
/// The caller is not authorized to perform this operation.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
///
/// You have exceeded the limit of tags that you can associate with the resource. A Kinesis
/// video stream can support up to 50 tags.
///
/// REST API Reference for TagStream Operation
TagStreamResponse TagStream(TagStreamRequest request);
///
/// Initiates the asynchronous execution of the TagStream operation.
///
///
/// Container for the necessary parameters to execute the TagStream operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagStream
/// operation.
/// REST API Reference for TagStream Operation
IAsyncResult BeginTagStream(TagStreamRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the TagStream operation.
///
///
/// The IAsyncResult returned by the call to BeginTagStream.
///
/// Returns a TagStreamResult from KinesisVideo.
/// REST API Reference for TagStream Operation
TagStreamResponse EndTagStream(IAsyncResult asyncResult);
#endregion
#region UntagResource
///
/// 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.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Initiates the asynchronous execution of the UntagResource operation.
///
///
/// Container for the necessary parameters to execute the UntagResource operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource
/// operation.
/// REST API Reference for UntagResource Operation
IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UntagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginUntagResource.
///
/// Returns a UntagResourceResult from KinesisVideo.
/// REST API Reference for UntagResource Operation
UntagResourceResponse EndUntagResource(IAsyncResult asyncResult);
#endregion
#region UntagStream
///
/// 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
.
///
///
/// Container for the necessary parameters to execute the UntagStream service method.
///
/// The response from the UntagStream service method, as returned by KinesisVideo.
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The format of the StreamARN
is invalid.
///
///
/// The caller is not authorized to perform this operation.
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for UntagStream Operation
UntagStreamResponse UntagStream(UntagStreamRequest request);
///
/// Initiates the asynchronous execution of the UntagStream operation.
///
///
/// Container for the necessary parameters to execute the UntagStream operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagStream
/// operation.
/// REST API Reference for UntagStream Operation
IAsyncResult BeginUntagStream(UntagStreamRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UntagStream operation.
///
///
/// The IAsyncResult returned by the call to BeginUntagStream.
///
/// Returns a UntagStreamResult from KinesisVideo.
/// REST API Reference for UntagStream Operation
UntagStreamResponse EndUntagStream(IAsyncResult asyncResult);
#endregion
#region UpdateDataRetention
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the UpdateDataRetention service method.
///
/// The response from the UpdateDataRetention service method, as returned by KinesisVideo.
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The caller is not authorized to perform this operation.
///
///
/// 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.
///
///
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
///
/// The stream version that you specified is not the latest version. To get the latest
/// version, use the DescribeStream
/// API.
///
/// REST API Reference for UpdateDataRetention Operation
UpdateDataRetentionResponse UpdateDataRetention(UpdateDataRetentionRequest request);
///
/// Initiates the asynchronous execution of the UpdateDataRetention operation.
///
///
/// Container for the necessary parameters to execute the UpdateDataRetention operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDataRetention
/// operation.
/// REST API Reference for UpdateDataRetention Operation
IAsyncResult BeginUpdateDataRetention(UpdateDataRetentionRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateDataRetention operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateDataRetention.
///
/// Returns a UpdateDataRetentionResult from KinesisVideo.
/// REST API Reference for UpdateDataRetention Operation
UpdateDataRetentionResponse EndUpdateDataRetention(IAsyncResult asyncResult);
#endregion
#region UpdateImageGenerationConfiguration
///
/// Updates the StreamInfo
and ImageProcessingConfiguration
/// fields.
///
/// Container for the necessary parameters to execute the UpdateImageGenerationConfiguration service method.
///
/// The response from the UpdateImageGenerationConfiguration service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The Stream data retention in hours is equal to zero.
///
///
/// 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.
///
///
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for UpdateImageGenerationConfiguration Operation
UpdateImageGenerationConfigurationResponse UpdateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest request);
///
/// Initiates the asynchronous execution of the UpdateImageGenerationConfiguration operation.
///
///
/// Container for the necessary parameters to execute the UpdateImageGenerationConfiguration operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateImageGenerationConfiguration
/// operation.
/// REST API Reference for UpdateImageGenerationConfiguration Operation
IAsyncResult BeginUpdateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateImageGenerationConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateImageGenerationConfiguration.
///
/// Returns a UpdateImageGenerationConfigurationResult from KinesisVideo.
/// REST API Reference for UpdateImageGenerationConfiguration Operation
UpdateImageGenerationConfigurationResponse EndUpdateImageGenerationConfiguration(IAsyncResult asyncResult);
#endregion
#region UpdateMediaStorageConfiguration
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the UpdateMediaStorageConfiguration service method.
///
/// The response from the UpdateMediaStorageConfiguration service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The Stream data retention in hours is equal to zero.
///
///
/// 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.
///
///
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for UpdateMediaStorageConfiguration Operation
UpdateMediaStorageConfigurationResponse UpdateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest request);
///
/// Initiates the asynchronous execution of the UpdateMediaStorageConfiguration operation.
///
///
/// Container for the necessary parameters to execute the UpdateMediaStorageConfiguration operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateMediaStorageConfiguration
/// operation.
/// REST API Reference for UpdateMediaStorageConfiguration Operation
IAsyncResult BeginUpdateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateMediaStorageConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateMediaStorageConfiguration.
///
/// Returns a UpdateMediaStorageConfigurationResult from KinesisVideo.
/// REST API Reference for UpdateMediaStorageConfiguration Operation
UpdateMediaStorageConfigurationResponse EndUpdateMediaStorageConfiguration(IAsyncResult asyncResult);
#endregion
#region UpdateNotificationConfiguration
///
/// Updates the notification information for a stream.
///
/// Container for the necessary parameters to execute the UpdateNotificationConfiguration service method.
///
/// The response from the UpdateNotificationConfiguration service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The Stream data retention in hours is equal to zero.
///
///
/// 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.
///
///
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
/// REST API Reference for UpdateNotificationConfiguration Operation
UpdateNotificationConfigurationResponse UpdateNotificationConfiguration(UpdateNotificationConfigurationRequest request);
///
/// Initiates the asynchronous execution of the UpdateNotificationConfiguration operation.
///
///
/// Container for the necessary parameters to execute the UpdateNotificationConfiguration operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateNotificationConfiguration
/// operation.
/// REST API Reference for UpdateNotificationConfiguration Operation
IAsyncResult BeginUpdateNotificationConfiguration(UpdateNotificationConfigurationRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateNotificationConfiguration operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateNotificationConfiguration.
///
/// Returns a UpdateNotificationConfigurationResult from KinesisVideo.
/// REST API Reference for UpdateNotificationConfiguration Operation
UpdateNotificationConfigurationResponse EndUpdateNotificationConfiguration(IAsyncResult asyncResult);
#endregion
#region UpdateSignalingChannel
///
/// 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.
///
///
/// Container for the necessary parameters to execute the UpdateSignalingChannel service method.
///
/// The response from the UpdateSignalingChannel service method, as returned by KinesisVideo.
///
/// You do not have required permissions to perform this operation.
///
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// 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.
///
///
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
///
/// The stream version that you specified is not the latest version. To get the latest
/// version, use the DescribeStream
/// API.
///
/// REST API Reference for UpdateSignalingChannel Operation
UpdateSignalingChannelResponse UpdateSignalingChannel(UpdateSignalingChannelRequest request);
///
/// Initiates the asynchronous execution of the UpdateSignalingChannel operation.
///
///
/// Container for the necessary parameters to execute the UpdateSignalingChannel operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateSignalingChannel
/// operation.
/// REST API Reference for UpdateSignalingChannel Operation
IAsyncResult BeginUpdateSignalingChannel(UpdateSignalingChannelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateSignalingChannel operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateSignalingChannel.
///
/// Returns a UpdateSignalingChannelResult from KinesisVideo.
/// REST API Reference for UpdateSignalingChannel Operation
UpdateSignalingChannelResponse EndUpdateSignalingChannel(IAsyncResult asyncResult);
#endregion
#region UpdateStream
///
/// 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.
///
///
/// Container for the necessary parameters to execute the UpdateStream service method.
///
/// The response from the UpdateStream service method, as returned by KinesisVideo.
///
/// Kinesis Video Streams has throttled the request because you have exceeded the limit
/// of allowed client calls. Try making the call later.
///
///
/// The value for this input parameter is invalid.
///
///
/// The caller is not authorized to perform this operation.
///
///
/// 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.
///
///
///
///
/// Amazon Kinesis Video Streams can't find the stream that you specified.
///
///
/// The stream version that you specified is not the latest version. To get the latest
/// version, use the DescribeStream
/// API.
///
/// REST API Reference for UpdateStream Operation
UpdateStreamResponse UpdateStream(UpdateStreamRequest request);
///
/// Initiates the asynchronous execution of the UpdateStream operation.
///
///
/// Container for the necessary parameters to execute the UpdateStream operation on AmazonKinesisVideoClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStream
/// operation.
/// REST API Reference for UpdateStream Operation
IAsyncResult BeginUpdateStream(UpdateStreamRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateStream operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateStream.
///
/// Returns a UpdateStreamResult from KinesisVideo.
/// REST API Reference for UpdateStream Operation
UpdateStreamResponse EndUpdateStream(IAsyncResult asyncResult);
#endregion
}
}