Package org.opensearch.client.transport.aws

Class AwsSdk2Transport

java.lang.Object

org.opensearch.client.transport.aws.AwsSdk2Transport

All Implemented Interfaces:

Closeable, AutoCloseable, OpenSearchTransport, Transport

public class AwsSdk2Transport
extends Object
implements OpenSearchTransport

Implementation of the OpenSearchTransport interface that sends signed requests using the AWS v2 SDK HTTP clients, to connect to an AWS OpenSearch service using IAM authentication.

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	DEFAULT_REQUEST_COMPRESSION_SIZE	By default, requests that exceed this size will be automatically compressed.

Constructor Summary

Constructors

Constructor	Description
AwsSdk2Transport(software.amazon.awssdk.http.async.SdkAsyncHttpClient asyncHttpClient, String host, String signingServiceName, software.amazon.awssdk.regions.Region signingRegion, AwsSdk2TransportOptions options)	Create an OpenSearchTransport with an asynchronous AWS HTTP client.
AwsSdk2Transport(software.amazon.awssdk.http.async.SdkAsyncHttpClient asyncHttpClient, String host, software.amazon.awssdk.regions.Region signingRegion, AwsSdk2TransportOptions options)	Create an OpenSearchTransport with an asynchronous AWS HTTP client.
AwsSdk2Transport(software.amazon.awssdk.http.SdkHttpClient syncHttpClient, String host, String signingServiceName, software.amazon.awssdk.regions.Region signingRegion, AwsSdk2TransportOptions options)	Create an OpenSearchTransport with a synchronous AWS HTTP client.
AwsSdk2Transport(software.amazon.awssdk.http.SdkHttpClient syncHttpClient, String host, software.amazon.awssdk.regions.Region signingRegion, AwsSdk2TransportOptions options)	Create an OpenSearchTransport with a synchronous AWS HTTP client.

Method Summary

Modifier and Type	Method	Description
void	close()
JsonpMapper	jsonpMapper()
AwsSdk2TransportOptions	options()	Default options used by this transport if none are provided in Transport.performRequest(Object, Endpoint, TransportOptions) or Transport.performRequestAsync(Object, Endpoint, TransportOptions);
<RequestT, ResponseT, ErrorT> ResponseT	performRequest(RequestT request, Endpoint<RequestT,ResponseT,ErrorT> endpoint, TransportOptions options)
<RequestT, ResponseT, ErrorT> CompletableFuture<ResponseT>	performRequestAsync(RequestT request, Endpoint<RequestT,ResponseT,ErrorT> endpoint, TransportOptions options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_REQUEST_COMPRESSION_SIZE

public static final Integer DEFAULT_REQUEST_COMPRESSION_SIZE

By default, requests that exceed this size will be automatically compressed. AwsSdk2TransportOptions can be used to override this setting or disable compression.

Constructor Details

AwsSdk2Transport

public AwsSdk2Transport(@CheckForNull
 software.amazon.awssdk.http.async.SdkAsyncHttpClient asyncHttpClient,
 @Nonnull
 String host,
 @Nonnull
 software.amazon.awssdk.regions.Region signingRegion,
 @CheckForNull
 AwsSdk2TransportOptions options)

Create an OpenSearchTransport with an asynchronous AWS HTTP client.

Note that asynchronous OpenSearch requests sent through this transport will be dispatched *synchronously* on the calling thread.

Parameters:

asyncHttpClient - Asynchronous HTTP client to use for OpenSearch requests.

host - The fully qualified domain name to connect to.

signingRegion - The AWS region for which requests will be signed. This should typically match the region in `host`.

options - Options that apply to all requests. Can be null. Create with AwsSdk2TransportOptions.builder() and use these to specify non-default credentials, compression options, etc.

AwsSdk2Transport

public AwsSdk2Transport(@CheckForNull
 software.amazon.awssdk.http.SdkHttpClient syncHttpClient,
 @Nonnull
 String host,
 @Nonnull
 software.amazon.awssdk.regions.Region signingRegion,
 @CheckForNull
 AwsSdk2TransportOptions options)

Create an OpenSearchTransport with a synchronous AWS HTTP client.

Parameters:

syncHttpClient - Synchronous HTTP client to use for OpenSearch requests.

host - The fully qualified domain name to connect to.

signingRegion - The AWS region for which requests will be signed. This should typically match the region in `host`.

options - Options that apply to all requests. Can be null. Create with AwsSdk2TransportOptions.builder() and use these to specify non-default credentials, compression options, etc.

Implementation Note:

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 OpenSearchClientBase.clearScroll(org.opensearch.client.opensearch.core.ClearScrollRequest) and OpenSearchClientBase.deletePit(org.opensearch.client.opensearch.core.pit.DeletePitRequest). As such performRequest(Object, Endpoint, TransportOptions) & performRequestAsync(Object, Endpoint, TransportOptions) will throw a TransportException if an unsupported request is encountered while using ApacheHttpClient.

AwsSdk2Transport

public AwsSdk2Transport(@CheckForNull
 software.amazon.awssdk.http.async.SdkAsyncHttpClient asyncHttpClient,
 @Nonnull
 String host,
 @Nonnull
 String signingServiceName,
 @Nonnull
 software.amazon.awssdk.regions.Region signingRegion,
 @CheckForNull
 AwsSdk2TransportOptions options)

Create an OpenSearchTransport with an asynchronous AWS HTTP client.

Note that asynchronous OpenSearch requests sent through this transport will be dispatched *synchronously* on the calling thread.

Parameters:

asyncHttpClient - Asynchronous HTTP client to use for OpenSearch requests.

host - The fully qualified domain name to connect to.

signingServiceName - The AWS signing service name, one of `es` (Amazon OpenSearch) or `aoss` (Amazon OpenSearch Serverless).

signingRegion - The AWS region for which requests will be signed. This should typically match the region in `host`.

options - Options that apply to all requests. Can be null. Create with AwsSdk2TransportOptions.builder() and use these to specify non-default credentials, compression options, etc.

AwsSdk2Transport

public AwsSdk2Transport(@CheckForNull
 software.amazon.awssdk.http.SdkHttpClient syncHttpClient,
 @Nonnull
 String host,
 @Nonnull
 String signingServiceName,
 @Nonnull
 software.amazon.awssdk.regions.Region signingRegion,
 @CheckForNull
 AwsSdk2TransportOptions options)

Create an OpenSearchTransport with a synchronous AWS HTTP client.

Parameters:

syncHttpClient - Synchronous HTTP client to use for OpenSearch requests.

host - The fully qualified domain name to connect to.

signingServiceName - The AWS signing service name, one of `es` (Amazon OpenSearch) or `aoss` (Amazon OpenSearch Serverless).

signingRegion - The AWS region for which requests will be signed. This should typically match the region in `host`.

options - Options that apply to all requests. Can be null. Create with AwsSdk2TransportOptions.builder() and use these to specify non-default credentials, compression options, etc.

Implementation Note:

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 OpenSearchClientBase.clearScroll(org.opensearch.client.opensearch.core.ClearScrollRequest) and OpenSearchClientBase.deletePit(org.opensearch.client.opensearch.core.pit.DeletePitRequest). As such performRequest(Object, Endpoint, TransportOptions) & performRequestAsync(Object, Endpoint, TransportOptions) will throw a TransportException if an unsupported request is encountered while using ApacheHttpClient.

Method Details

performRequest

public <RequestT,
ResponseT,
ErrorT> ResponseT performRequest(RequestT request,
 Endpoint<RequestT,ResponseT,ErrorT> endpoint,
 @Nullable
 TransportOptions options)
                                                       throws IOException

Specified by:

performRequest in interface Transport

Throws:

IOException

performRequestAsync

public <RequestT,
ResponseT,
ErrorT>
CompletableFuture<ResponseT> performRequestAsync(RequestT request,
 Endpoint<RequestT,ResponseT,ErrorT> endpoint,
 @Nullable
 TransportOptions options)

Specified by:

performRequestAsync in interface Transport

jsonpMapper

public JsonpMapper jsonpMapper()

Specified by:

jsonpMapper in interface Transport

options

public AwsSdk2TransportOptions options()

Description copied from interface: Transport

Default options used by this transport if none are provided in Transport.performRequest(Object, Endpoint, TransportOptions) or Transport.performRequestAsync(Object, Endpoint, TransportOptions);

Specified by:

options in interface Transport

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable