Skip to content

ConsumerDescription

Source code in docs_src/capo_kinesis/types/consumer_description.py 
17
18
19
20
21
22
23
24
25
26
27
class ConsumerDescription(TypedDict, closed=True):
    consumer_name: "capo_kinesis.types.consumer_name.ConsumerName"
    """<p>The name of the consumer is something you choose when you register the consumer.</p>"""
    consumer_arn: "capo_kinesis.types.consumer_arn.ConsumerARN"
    """<p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call <a>SubscribeToShard</a>.</p> <p>If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.</p>"""
    consumer_status: "capo_kinesis.types.consumer_status.ConsumerStatus"
    """<p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code> states.</p>"""
    consumer_creation_timestamp: "capo_kinesis.types.timestamp.Timestamp"
    """<p></p>"""
    stream_arn: "capo_kinesis.types.stream_arn.StreamARN"
    """<p>The ARN of the stream with which you registered the consumer.</p>"""

consumer_arn instance-attribute 

consumer_arn: ConsumerARN

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

consumer_creation_timestamp instance-attribute 

consumer_creation_timestamp: Timestamp

consumer_name instance-attribute 

consumer_name: ConsumerName

The name of the consumer is something you choose when you register the consumer.

consumer_status instance-attribute 

consumer_status: ConsumerStatus

A consumer can't read data while in the CREATING or DELETING states.

stream_arn instance-attribute 

stream_arn: StreamARN

The ARN of the stream with which you registered the consumer.