Struct aws_sdk_kinesis::model::ConsumerDescription

#[non_exhaustive]
pub struct ConsumerDescription { /* private fields */ }

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

Implementations

impl ConsumerDescription

pub fn consumer_name(&self) -> Option<&str>

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

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.

pub fn consumer_status(&self) -> Option<&ConsumerStatus>

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

pub fn consumer_creation_timestamp(&self) -> Option<&DateTime>

pub fn stream_arn(&self) -> Option<&str>

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

impl ConsumerDescription

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ConsumerDescription.

Trait Implementations

impl Clone for ConsumerDescription

fn clone(&self) -> ConsumerDescription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConsumerDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ConsumerDescription> for ConsumerDescription

fn eq(&self, other: &ConsumerDescription) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConsumerDescription