aws kinesis describe-stream-consumer

To get the description of a registered consumer, provide the ARN of the consumer. AWS CLI reference

1 example 4 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To describe a data stream consumer

The following describe-stream-consumer example returns the description of the specified consumer, registered with the specified data stream.

aws kinesis describe-stream-consumer --stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/samplestream --consumer-name KinesisConsumerApplication

Identify

--stream-arnThe ARN of the Kinesis data stream that the consumer is registered with.

--consumer-nameThe name that you gave to the consumer.

Its output

{
    "ConsumerDescription": {
        "ConsumerName": "KinesisConsumerApplication",
        "ConsumerARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream/consumer/KinesisConsumerApplication:1572383852",
        "ConsumerStatus": "ACTIVE",
        "ConsumerCreationTimestamp": 1572383852.0,
        "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream"
    }
}

For more information, see Reading Data from Amazon Kinesis Data Streams in the Amazon Kinesis Data Streams Developer Guide.

Options

4 in the AWS CLI reference

--consumer-arnThe ARN returned by Kinesis Data Streams when you registered the consumer.

--consumer-nameThe name that you gave to the consumer.

--stream-arnThe ARN of the Kinesis data stream that the consumer is registered with.

--stream-idNot Implemented.