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.

Classes

NameDescription
Class AccountStreamLimitExceededException

KinesisVideo exception

Class ClientLimitExceededException

KinesisVideo exception

Class CreateStreamRequest

Container for the parameters to the CreateStream operation. 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.

Class CreateStreamResponse

This is the response object from the CreateStream operation.

Class DeleteStreamRequest

Container for the parameters to the DeleteStream operation. 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.

Class DeleteStreamResponse

This is the response object from the DeleteStream operation.

Class DescribeStreamRequest

Container for the parameters to the DescribeStream operation. Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

Class DescribeStreamResponse

This is the response object from the DescribeStream operation.

Class DeviceStreamLimitExceededException

KinesisVideo exception

Class GetDataEndpointRequest

Container for the parameters to the GetDataEndpoint operation. 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.

Class GetDataEndpointResponse

This is the response object from the GetDataEndpoint operation.

Class InvalidArgumentException

KinesisVideo exception

Class InvalidDeviceException

KinesisVideo exception

Class InvalidResourceFormatException

KinesisVideo exception

Class ListStreamsRequest

Container for the parameters to the ListStreams operation. 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.

Class ListStreamsResponse

This is the response object from the ListStreams operation.

Class ListTagsForStreamRequest

Container for the parameters to the ListTagsForStream operation. Returns a list of tags associated with the specified stream.

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

Class ListTagsForStreamResponse

This is the response object from the ListTagsForStream operation.

Class NotAuthorizedException

KinesisVideo exception

Class ResourceInUseException

KinesisVideo exception

Class ResourceNotFoundException

KinesisVideo exception

Class StreamInfo

An object describing a Kinesis video stream.

Class StreamNameCondition

Specifies the condition that streams must satisfy to be returned when you list streams (see the ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

Class TagsPerResourceExceededLimitException

KinesisVideo exception

Class TagStreamRequest

Container for the parameters to the TagStream operation. 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.

Class TagStreamResponse

This is the response object from the TagStream operation.

Class UntagStreamRequest

Container for the parameters to the UntagStream operation. 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.

Class UntagStreamResponse

This is the response object from the UntagStream operation.

Class UpdateDataRetentionRequest

Container for the parameters to the UpdateDataRetention operation. 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.

Class UpdateDataRetentionResponse

This is the response object from the UpdateDataRetention operation.

Class UpdateStreamRequest

Container for the parameters to the UpdateStream operation. 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.

Class UpdateStreamResponse

This is the response object from the UpdateStream operation.

Class VersionMismatchException

KinesisVideo exception