awslabs / results-iterator-for-aws-java-sdk Goto Github PK

A library that handles iterating over results from the AWS Java SDK with minimal boilerplate. It also contains additional convenience functions that make the AWS Java SDKs even easier to work with.

AWS allows applications to use certificates registered in AWS IoT to make direct calls to AWS services. Using this requires a small amount of setup but it is the best way to make sure hard-coded IAM credentials are not being shared.

Only the v2 SDK is supported now.

This library has Dagger modules that simplify the setup of AWS SDK clients and the classes that enable the iteration functions.

v2 Dagger helper module

This library is designed to return streams. There is no need to worry about pagination as those details are all taken care of for you.

Example: Find all buckets you have access to that start with "sagemaker":

  ResultsIterator<Bucket> bucketIterator = new ResultsIterator<>(s3Client, ListBucketsRequest.class);
  List<Bucket> sageMakerBuckets = bucketIterator.stream()
                .filter(bucket -> bucket.name().startsWith("sagemaker"))
                .collect(Collectors.toList());

If you work with S3 buckets in different regions this library will automatically give you the correct, region-specific client:

Example: Get a region-specific S3 client for a bucket, regardless of your default region:

  S3Client regionSpecificS3Client = s3Helper.getRegionSpecificClientForBucket(bucket);

1. Add the jitpack repo to the repositories section

   maven { url 'https://jitpack.io' }
   

2. Add the dependency version (replace x.y.z with the appropriate version from the JitPack site)

   def resultsIteratorForAwsJavaSdkVersion = 'x.y.z'
   

3. Add the dependency to the dependencies section

   compile "com.github.awslabs:results-iterator-for-aws-java-sdk:$resultsIteratorForAwsJavaSdkVersion"
   

Check out an example in the IoT reference architectures repo.

If you're using Dagger you can use the V1HelperModule and HelperModule classes in your own components (AKA injectors) to get SDK clients and helper objects that are constructed with sane defaults.

If you need to configure the SDK client classes you can instead get a builder that is pre-populated with the default values that can all be overridden.

See the TestV1ResultsIterator and TestResultsIterator test classes to see how the normal classes are used.

The TestResultsIterator.listAll method shows how to use a builder provider to build an S3Client object that connects to a different region when a bucket is not located in the region that the default injected S3Client is configured for.

This library is licensed under the Apache 2.0 License.