Skip to content

RegisterStreamConsumerInput

Source code in docs_src/capo_kinesis/types/register_stream_consumer_input.py 
16
17
18
19
20
21
22
23
24
class RegisterStreamConsumerInput(TypedDict, closed=True):
    stream_arn: "capo_kinesis.types.stream_arn.StreamARN"
    """<p>The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>"""
    consumer_name: "capo_kinesis.types.consumer_name.ConsumerName"
    """<p>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.</p>"""
    stream_id: NotRequired["capo_kinesis.types.stream_id.StreamId"]
    """<p>Not Implemented. Reserved for future use.</p>"""
    tags: NotRequired["capo_kinesis.types.tag_map.TagMap"]
    """<p>A set of up to 50 key-value pairs. A tag consists of a required key and an optional value.</p>"""

consumer_name instance-attribute 

consumer_name: ConsumerName

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: StreamARN

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: NotRequired[StreamId]

Not Implemented. Reserved for future use.

tags instance-attribute 

tags: NotRequired[TagMap]

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