AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing KinesisVideo

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.KinesisVideo.AmazonKinesisVideoClient

Namespace: Amazon.KinesisVideo
Assembly: AWSSDK.KinesisVideo.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonKinesisVideoClient : AmazonServiceClient
         IAmazonKinesisVideo, IAmazonService, IDisposable

The AmazonKinesisVideoClient type exposes the following members

Constructors

NameDescription
Public Method AmazonKinesisVideoClient()

Constructs AmazonKinesisVideoClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonKinesisVideoClient(RegionEndpoint)

Constructs AmazonKinesisVideoClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonKinesisVideoClient(AmazonKinesisVideoConfig)

Constructs AmazonKinesisVideoClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonKinesisVideoClient(AWSCredentials)

Constructs AmazonKinesisVideoClient with AWS Credentials

Public Method AmazonKinesisVideoClient(AWSCredentials, RegionEndpoint)

Constructs AmazonKinesisVideoClient with AWS Credentials

Public Method AmazonKinesisVideoClient(AWSCredentials, AmazonKinesisVideoConfig)

Constructs AmazonKinesisVideoClient with AWS Credentials and an AmazonKinesisVideoClient Configuration object.

Public Method AmazonKinesisVideoClient(string, string)

Constructs AmazonKinesisVideoClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonKinesisVideoClient(string, string, RegionEndpoint)

Constructs AmazonKinesisVideoClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonKinesisVideoClient(string, string, AmazonKinesisVideoConfig)

Constructs AmazonKinesisVideoClient with AWS Access Key ID, AWS Secret Key and an AmazonKinesisVideoClient Configuration object.

Public Method AmazonKinesisVideoClient(string, string, string)

Constructs AmazonKinesisVideoClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonKinesisVideoClient(string, string, string, RegionEndpoint)

Constructs AmazonKinesisVideoClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonKinesisVideoClient(string, string, string, AmazonKinesisVideoConfig)

Constructs AmazonKinesisVideoClient with AWS Access Key ID, AWS Secret Key and an AmazonKinesisVideoClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateStream(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.

Public Method CreateStreamAsync(CreateStreamRequest, CancellationToken)

Initiates the asynchronous execution of the CreateStream operation.

Public Method DeleteStream(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.

Public Method DeleteStreamAsync(DeleteStreamRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteStream operation.

Public Method DescribeStream(DescribeStreamRequest)

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

Public Method DescribeStreamAsync(DescribeStreamRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeStream operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetDataEndpoint(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.

Public Method GetDataEndpointAsync(GetDataEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the GetDataEndpoint operation.

Public Method ListStreams(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.

Public Method ListStreamsAsync(ListStreamsRequest, CancellationToken)

Initiates the asynchronous execution of the ListStreams operation.

Public Method ListTagsForStream(ListTagsForStreamRequest)

Returns a list of tags associated with the specified stream.

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

Public Method ListTagsForStreamAsync(ListTagsForStreamRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForStream operation.

Public Method TagStream(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 AWS 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 AWS Billing and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

Kinesis video streams support up to 50 tags.

Public Method TagStreamAsync(TagStreamRequest, CancellationToken)

Initiates the asynchronous execution of the TagStream operation.

Public Method UntagStream(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.

Public Method UntagStreamAsync(UntagStreamRequest, CancellationToken)

Initiates the asynchronous execution of the UntagStream operation.

Public Method UpdateDataRetention(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.

Public Method UpdateDataRetentionAsync(UpdateDataRetentionRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDataRetention operation.

Public Method UpdateStream(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.

Public Method UpdateStreamAsync(UpdateStreamRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateStream operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms