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.

Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream.

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

AddTagsToStream has a limit of five transactions per second per account.

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 BeginAddTagsToStream and EndAddTagsToStream.

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

Syntax

C#
public abstract Task<AddTagsToStreamResponse> AddTagsToStreamAsync(
         AddTagsToStreamRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Kinesis.Model.AddTagsToStreamRequest

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

Exceptions

ExceptionCondition
AccessDeniedException Specifies that you do not have the permissions required to perform this operation.
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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also