Struct aws_sdk_kinesis::model::Consumer
source · #[non_exhaustive]pub struct Consumer { /* private fields */ }
Expand description
An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer
.
Implementations§
source§impl Consumer
impl Consumer
sourcepub fn consumer_name(&self) -> Option<&str>
pub fn consumer_name(&self) -> Option<&str>
The name of the consumer is something you choose when you register the consumer.
sourcepub fn consumer_arn(&self) -> Option<&str>
pub fn consumer_arn(&self) -> Option<&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.
sourcepub fn consumer_status(&self) -> Option<&ConsumerStatus>
pub fn consumer_status(&self) -> Option<&ConsumerStatus>
A consumer can't read data while in the CREATING
or DELETING
states.