The documentation doesn't match what's in a JAR file.

[yampolskiy]

For example where is this package at? com.amazonaws.services.kinesis.model

[gauravgh]

The com.amazonaws.services.kinesis.model package comes from the AWS SDK for Java (which is a dependency of the Kinesis Client Library).

Can you point us to the documentation where we can make this clearer (e.g. is it the README for this repository, or the documentation on the AWS website)?

Thank you,
-Gaurav

[thatjpk]

Are there even javadocs for amazon-kinesis-client posted anywhere? You're right yampolskiy is probably talking about the Java SDK docs (at http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/index.html), but if one wants to read the javadoc for a class in this project (say, KinesisClientLibConfiguration), where can we find it?

[gauravgh]

We'll look into publishing a javadocs page for amazon-kinesis-client. Currently, the javadocs are in the source code and available as a jar via Maven.

Thank you,
Gaurav

[thatjpk]

Right on. I'm not very familiar with maven, but found mvn javadoc:jar source:jar built the javadoc and source jars I could point Eclipse at. I'd recommend putting that in this project's README.

Thanks for your help!

[brendan-p-lynch]

Here is an example of the javadoc for the most recent release of KCL v1.x. https://javadoc.io/static/com.amazonaws/amazon-kinesis-client/1.15.1/index.html?com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.html