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.
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.
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 BeginUpdateStream and EndUpdateStream.
Namespace: Amazon.KinesisVideo
Assembly: AWSSDK.KinesisVideo.dll
Version: 3.x.y.z
public abstract Task<UpdateStreamResponse> UpdateStreamAsync( UpdateStreamRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the UpdateStream service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| 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. |
| ResourceInUseException | 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. |
| ResourceNotFoundException | Amazon Kinesis Video Streams can't find the stream that you specified. |
| VersionMismatchException | The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5