aws kinesis register-stream-consumer

Registers a consumer with a Kinesis data stream. AWS CLI reference

1 example 4 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To register a data stream consumer

The following register-stream-consumer example registers a consumer called KinesisConsumerApplication with the specified data stream.

aws kinesis register-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 you want to register the consumer with.

--consumer-nameFor a given Kinesis data stream, each consumer must have a unique name.

Its output

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

For more information, see Developing Consumers with Enhanced Fan-Out Using the Kinesis Data Streams API in the Amazon Kinesis Data Streams Developer Guide.

Options

4 in the AWS CLI reference

--consumer-nameFor a given Kinesis data stream, each consumer must have a unique name.

--stream-arnThe ARN of the Kinesis data stream that you want to register the consumer with.

--stream-idNot Implemented.

--tagsA set of up to 50 key-value pairs.