Amazon Kinesis Data Streams Service API Reference
API Reference (API Version 2013-12-02)

ConsumerDescription

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

Contents

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+

Required: Yes

ConsumerCreationTimestamp

Type: Timestamp

Required: Yes

ConsumerName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

ConsumerStatus

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

Type: String

Valid Values: CREATING | DELETING | ACTIVE

Required: Yes

StreamARN

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws.*:kinesis:.*:\d{12}:stream/.*

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: