Skip to content

Kinesis  >  Structures  >  ConsumerDescription

ConsumerDescription

Structure Class

ConsumerDescription dataclass

Bases: _SerdeShape

An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.

Attributes

consumer_arn instance-attribute 
consumer_arn: str

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: datetime
consumer_name instance-attribute 
consumer_name: str

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

consumer_status instance-attribute 
consumer_status: str

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

stream_arn instance-attribute 
stream_arn: str

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