Adding documentation comment

Signed-off-by: Vacha Shah <vachshah@amazon.com>
opensearch-project · Jan 21, 2023 · a5a4ac8 · a5a4ac8
1 parent 81f1045
commit a5a4ac8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/java-client/src/main/java/org/opensearch/client/transport/aws/AwsSdk2Transport.java b/java-client/src/main/java/org/opensearch/client/transport/aws/AwsSdk2Transport.java
@@ -363,6 +363,9 @@ private <RequestT> SdkHttpFullRequest prepareRequest(
             }
             req.putHeader("Content-Length", String.valueOf(body.getContentLength()));
             req.contentStreamProvider(body::getInputStream);
+            // To add the "X-Amz-Content-Sha256" header, it needs to set as required.
+            // See https://github.com/aws/aws-sdk-java-v2/blob/0510a17ae41d601cf5f03e7af01e4519a6b3a744/core/auth/src/main/java/software/amazon/awssdk/auth/signer/internal/AbstractAws4Signer.java#L97
+            // It is a required header for Amazon OpenSearch Serverless.
             req.putHeader("x-amz-content-sha256", "required");
         }