NAME

Paws::Kinesis::ConsumerDescription

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Kinesis::ConsumerDescription object:

  $service_obj->Method(Att1 => { ConsumerARN => $value, ..., StreamARN => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Kinesis::ConsumerDescription object:

  $result = $service_obj->Method(...);
  $result->Att1->ConsumerARN

DESCRIPTION

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

ATTRIBUTES

REQUIRED ConsumerARN => 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.

REQUIRED ConsumerCreationTimestamp => Str

REQUIRED ConsumerName => Str

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

REQUIRED ConsumerStatus => Str

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

REQUIRED StreamARN => Str

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>