From 147302b39816a09f9a30dc3bcf1dce5319f0cc07 Mon Sep 17 00:00:00 2001 From: Justin Pfifer Date: Tue, 6 Feb 2018 13:53:58 -0800 Subject: [PATCH] Add a warning about ListShards and IAM Polices (#296) * Add a warning about ListShards and IAM Polices * Corrected some spelling errors * Add the same warning to the changelog Added the warning from the README.md to the CHANGELOG.md. --- CHANGELOG.md | 7 ++++--- README.md | 15 ++++++++------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ed3d16dd..6ece144c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,8 @@ ## Release 1.9.0 (February 6, 2018) * Introducing support for ListShards API. This API is used in place of DescribeStream API to provide more throughput during ShardSyncTask. Please consult the [AWS Documentation for ListShards](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListShards.html) for more information. - * ListShards supoorts higher call rate, which should reduce instances of throttling when attempting to synchronize the shard list. + * ListShards supports higher call rate, which should reduce instances of throttling when attempting to synchronize the shard list. + * __WARNING: `ListShards` is a new API, and may require updating any explicit IAM policies__ * Added configuration parameters for ListShards usage | Name | Default | Description | @@ -11,7 +12,7 @@ | [listShardsRetryAttempts](https://github.com/awslabs/amazon-kinesis-client/blob/3ae916c5fcdccd6b835c86ba7f6f53dd5b4c8b04/src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.java#L1423) | 50 | This is the maximum number of times the KinesisProxy will retry to make ListShards calls on being throttled. | * Updating the version of AWS Java SDK to 1.11.272. - * Version 1.11.272 is now the minimum support versiojn of the SDK. + * Version 1.11.272 is now the minimum support version of the SDK. * Deprecating the following methods, and classes. These methods, and classes will be removed in a future release. * Deprecated [IKinesisProxy#getStreamInfo](https://github.com/awslabs/amazon-kinesis-client/blob/3ae916c5fcdccd6b835c86ba7f6f53dd5b4c8b04/src/main/java/com/amazonaws/services/kinesis/clientlibrary/proxies/IKinesisProxy.java#L48-L62). * Deprecated [IKinesisProxyFactory](https://github.com/awslabs/amazon-kinesis-client/blob/3ae916c5fcdccd6b835c86ba7f6f53dd5b4c8b04/src/main/java/com/amazonaws/services/kinesis/clientlibrary/proxies/IKinesisProxyFactory.java). @@ -291,4 +292,4 @@ [kinesis-guide-kpl]: http://docs.aws.amazon.com//kinesis/latest/dev/developing-producers-with-kpl.html [kinesis-guide-consumer-deaggregation]: http://docs.aws.amazon.com//kinesis/latest/dev/kinesis-kpl-consumer-deaggregation.html [kclpy]: https://github.com/awslabs/amazon-kinesis-client-python -[multi-lang-protocol]: https://github.com/awslabs/amazon-kinesis-client/blob/master/src/main/java/com/amazonaws/services/kinesis/multilang/package-info.java \ No newline at end of file +[multi-lang-protocol]: https://github.com/awslabs/amazon-kinesis-client/blob/master/src/main/java/com/amazonaws/services/kinesis/multilang/package-info.java diff --git a/README.md b/README.md index c8869c07..1458631e 100644 --- a/README.md +++ b/README.md @@ -32,16 +32,17 @@ To make it easier for developers to write record processors in other languages, ### Latest Release (1.9.0) * Introducing support for ListShards API. This API is used in place of DescribeStream API to provide more throughput during ShardSyncTask. Please consult the [AWS Documentation for ListShards](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListShards.html) for more information. - * ListShards supoorts higher call rate, which should reduce instances of throttling when attempting to synchronize the shard list. - * Added configuration parameters for ListShards usage + * ListShards supports higher call rate, which should reduce instances of throttling when attempting to synchronize the shard list. + * __WARNING: `ListShards` is a new API, and may require updating any explicit IAM policies__ + * Added configuration parameters for ListShards usage - | Name | Default | Description | - | ---- | ------- | ----------- | - | [listShardsBackoffTimeInMillis](https://github.com/awslabs/amazon-kinesis-client/blob/3ae916c5fcdccd6b835c86ba7f6f53dd5b4c8b04/src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.java#L1412) | 1500 ms | This is the default backoff time between 2 ListShards calls when throttled. | - | [listShardsRetryAttempts](https://github.com/awslabs/amazon-kinesis-client/blob/3ae916c5fcdccd6b835c86ba7f6f53dd5b4c8b04/src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.java#L1423) | 50 | This is the maximum number of times the KinesisProxy will retry to make ListShards calls on being throttled. | + | Name | Default | Description | + | ---- | ------- | ----------- | + | [listShardsBackoffTimeInMillis](https://github.com/awslabs/amazon-kinesis-client/blob/3ae916c5fcdccd6b835c86ba7f6f53dd5b4c8b04/src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.java#L1412) | 1500 ms | This is the default backoff time between 2 ListShards calls when throttled. | + | [listShardsRetryAttempts](https://github.com/awslabs/amazon-kinesis-client/blob/3ae916c5fcdccd6b835c86ba7f6f53dd5b4c8b04/src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.java#L1423) | 50 | This is the maximum number of times the KinesisProxy will retry to make ListShards calls on being throttled. | * Updating the version of AWS Java SDK to 1.11.272. - * Version 1.11.272 is now the minimum support versiojn of the SDK. + * Version 1.11.272 is now the minimum support version of the SDK. * Deprecating the following methods, and classes. These methods, and classes will be removed in a future release. * Deprecated [IKinesisProxy#getStreamInfo](https://github.com/awslabs/amazon-kinesis-client/blob/3ae916c5fcdccd6b835c86ba7f6f53dd5b4c8b04/src/main/java/com/amazonaws/services/kinesis/clientlibrary/proxies/IKinesisProxy.java#L48-L62). * Deprecated [IKinesisProxyFactory](https://github.com/awslabs/amazon-kinesis-client/blob/3ae916c5fcdccd6b835c86ba7f6f53dd5b4c8b04/src/main/java/com/amazonaws/services/kinesis/clientlibrary/proxies/IKinesisProxyFactory.java).