Skip to content

Kinesis  >  Operations  >  register_stream_consumer

register_stream_consumer

Operation

register_stream_consumer async

register_stream_consumer(request: RegisterStreamConsumerInput | RegisterStreamConsumerInputDict, /, *, plugins: list[Plugin] | None = None) -> RegisterStreamConsumerOutput
register_stream_consumer(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[RegisterStreamConsumerInputDict]) -> RegisterStreamConsumerOutput

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 add tags to the registered consumer when making a RegisterStreamConsumer 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.

With On-demand Advantage streams, you can register up to 50 consumers per stream to use Enhanced Fan-out. With On-demand Standard and Provisioned streams, you can register up to 20 consumers per stream to use Enhanced Fan-out. 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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
RegisterStreamConsumerOutput

An instance of RegisterStreamConsumerOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

RegisterStreamConsumerInput dataclass

Bases: _SerdeShape

Dataclass for RegisterStreamConsumerInput structure.

Attributes
consumer_name class-attribute instance-attribute
consumer_name: str | None = ...

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.

stream_arn class-attribute instance-attribute
stream_arn: str | None = ...

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.

stream_id class-attribute instance-attribute
stream_id: str | None = ...

Not Implemented. Reserved for future use.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

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

Dictionaries

RegisterStreamConsumerInputDict

Bases: TypedDict

Dictionary form of RegisterStreamConsumerInput.

Attributes
consumer_name instance-attribute
consumer_name: Required[str]

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.

stream_arn instance-attribute
stream_arn: Required[str]

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.

stream_id instance-attribute
stream_id: str | None

Not Implemented. Reserved for future use.

tags instance-attribute
tags: Mapping[str, str] | None

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

Output

RegisterStreamConsumerOutput dataclass

Bases: _SerdeShape

Dataclass for RegisterStreamConsumerOutput structure.

Attributes

consumer instance-attribute
consumer: Consumer

An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN that is generated by Kinesis Data Streams.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.