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.

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

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeStream and EndDescribeStream.

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

Syntax

C#
public abstract Task<DescribeStreamResponse> DescribeStreamAsync(
         DescribeStreamRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.KinesisVideo.Model.DescribeStreamRequest

Container for the necessary parameters to execute the DescribeStream service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeStream service method, as returned by KinesisVideo.

Exceptions

ExceptionCondition
ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
InvalidArgumentException The value for this input parameter is invalid.
NotAuthorizedException The caller is not authorized to perform this operation.
ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also