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.
Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.
You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.
For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API.
The use of this operation has a limit of five transactions per second per account.
Also, only 5 consumers can be created simultaneously. In other words, you cannot have
more than 5 consumers in a CREATING status at the same time. Registering a
6th consumer while there are 5 in a CREATING status results in a LimitExceededException.
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 BeginRegisterStreamConsumer and EndRegisterStreamConsumer.
Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public abstract Task<RegisterStreamConsumerResponse> RegisterStreamConsumerAsync( RegisterStreamConsumerRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the RegisterStreamConsumer service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| 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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5