auth.md

• Authentication
  • Amazon OpenSearch Service

Authentication

Amazon OpenSearch Service

Requests to OpenSearch Service and OpenSearch Serverless must be signed using the AWS signing protocol. Use AwsSdk2Transport to send signed requests.

⚠️ Warning ⚠️
Using software.amazon.awssdk.http.apache.ApacheHttpClient is discouraged as it does not support request bodies on GET or DELETE requests.
This leads to incorrect handling of requests such as OpenSearchClient.clearScroll() and OpenSearchClient.deletePit().
As such AwsSdk2Transport will throw a TransportException if an unsupported request is encountered while using ApacheHttpClient.

SdkHttpClient httpClient = AwsCrtHttpClient.builder().build();

OpenSearchClient client = new OpenSearchClient(
    new AwsSdk2Transport(
        httpClient,
        "search-...us-west-2.es.amazonaws.com", // OpenSearch endpoint, without https://
        "es", // signing service name, use "aoss" for OpenSearch Serverless
        Region.US_WEST_2, // signing service region
        AwsSdk2TransportOptions.builder().build()
    )
);

InfoResponse info = client.info();
System.out.println(info.version().distribution() + ": " + info.version().number());

httpClient.close();