Skip to content

Register Stream Consumer

kinesis_register_stream_consumer R Documentation

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 then call subscribe_to_shard 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 add tags to the registered consumer when making a register_stream_consumer request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:RegisterStreamConsumer permission, you must also have the kinesis:TagResource permission for the consumer that will be registered. Tags will take effect from the CREATING status of the consumer.

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 operation, 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.

Usage

kinesis_register_stream_consumer(StreamARN, ConsumerName, Tags)

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 Amazon Web Services 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.
Tags

A set of up to 50 key-value pairs. A tag consists of a required key and an optional value.

Value

A list with the following syntax:

list(
  Consumer = list(
    ConsumerName = "string",
    ConsumerARN = "string",
    ConsumerStatus = "CREATING"|"DELETING"|"ACTIVE",
    ConsumerCreationTimestamp = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

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