From 27879bdef30f05700111630a03ae2749adacc205 Mon Sep 17 00:00:00 2001 From: "Pfifer, Justin" Date: Tue, 6 Feb 2018 13:18:19 -0800 Subject: [PATCH] Add a warning about ListShards and IAM Polices --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c8869c07..903407ba 100644 --- a/README.md +++ b/README.md @@ -33,12 +33,13 @@ 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 + * __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.