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.

Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data stream.

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 BeginUpdateStreamMode and EndUpdateStreamMode.

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

Syntax

C#
public abstract Task<UpdateStreamModeResponse> UpdateStreamModeAsync(
         UpdateStreamModeRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Kinesis.Model.UpdateStreamModeRequest

Container for the necessary parameters to execute the UpdateStreamMode 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 UpdateStreamMode service method, as returned by Kinesis.

Exceptions

ExceptionCondition
InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.
ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also