paws.analytics (version 0.1.0)

kinesis_register_stream_consumer: Registers a consumer with a Kinesis data stream

Description

Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can read data from the stream at a rate of up to 2 MiB per second. This rate is unaffected by the total number of consumers that read from the same stream.

Usage

kinesis_register_stream_consumer(StreamARN, ConsumerName)

Arguments

StreamARN

[required] The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

ConsumerName

[required] For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

Request syntax

svc$register_stream_consumer(
  StreamARN = "string",
  ConsumerName = "string"
)

Details

You can register up to 5 consumers per stream. A given consumer can only be registered with one stream.

This operation has a limit of five transactions per second per account.