Interface OpenSearchServerlessAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface OpenSearchServerlessAsyncClient extends AwsClient
Service client for accessing OpenSearch Service Serverless asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.

To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless?

  • Field Details

  • Method Details

    • batchGetCollection

      default CompletableFuture<BatchGetCollectionResponse> batchGetCollection(BatchGetCollectionRequest batchGetCollectionRequest)

      Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

      Parameters:
      batchGetCollectionRequest -
      Returns:
      A Java Future containing the result of the BatchGetCollection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetCollection

      default CompletableFuture<BatchGetCollectionResponse> batchGetCollection(Consumer<BatchGetCollectionRequest.Builder> batchGetCollectionRequest)

      Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.


      This is a convenience which creates an instance of the BatchGetCollectionRequest.Builder avoiding the need to create one manually via BatchGetCollectionRequest.builder()

      Parameters:
      batchGetCollectionRequest - A Consumer that will call methods on BatchGetCollectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetCollection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetEffectiveLifecyclePolicy

      default CompletableFuture<BatchGetEffectiveLifecyclePolicyResponse> batchGetEffectiveLifecyclePolicy(BatchGetEffectiveLifecyclePolicyRequest batchGetEffectiveLifecyclePolicyRequest)

      Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.

      Parameters:
      batchGetEffectiveLifecyclePolicyRequest -
      Returns:
      A Java Future containing the result of the BatchGetEffectiveLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetEffectiveLifecyclePolicy

      default CompletableFuture<BatchGetEffectiveLifecyclePolicyResponse> batchGetEffectiveLifecyclePolicy(Consumer<BatchGetEffectiveLifecyclePolicyRequest.Builder> batchGetEffectiveLifecyclePolicyRequest)

      Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.


      This is a convenience which creates an instance of the BatchGetEffectiveLifecyclePolicyRequest.Builder avoiding the need to create one manually via BatchGetEffectiveLifecyclePolicyRequest.builder()

      Parameters:
      batchGetEffectiveLifecyclePolicyRequest - A Consumer that will call methods on BatchGetEffectiveLifecyclePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetEffectiveLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetLifecyclePolicy

      default CompletableFuture<BatchGetLifecyclePolicyResponse> batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest batchGetLifecyclePolicyRequest)

      Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

      Parameters:
      batchGetLifecyclePolicyRequest -
      Returns:
      A Java Future containing the result of the BatchGetLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetLifecyclePolicy

      default CompletableFuture<BatchGetLifecyclePolicyResponse> batchGetLifecyclePolicy(Consumer<BatchGetLifecyclePolicyRequest.Builder> batchGetLifecyclePolicyRequest)

      Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.


      This is a convenience which creates an instance of the BatchGetLifecyclePolicyRequest.Builder avoiding the need to create one manually via BatchGetLifecyclePolicyRequest.builder()

      Parameters:
      batchGetLifecyclePolicyRequest - A Consumer that will call methods on BatchGetLifecyclePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetVpcEndpoint

      default CompletableFuture<BatchGetVpcEndpointResponse> batchGetVpcEndpoint(BatchGetVpcEndpointRequest batchGetVpcEndpointRequest)

      Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

      Parameters:
      batchGetVpcEndpointRequest -
      Returns:
      A Java Future containing the result of the BatchGetVpcEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetVpcEndpoint

      default CompletableFuture<BatchGetVpcEndpointResponse> batchGetVpcEndpoint(Consumer<BatchGetVpcEndpointRequest.Builder> batchGetVpcEndpointRequest)

      Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.


      This is a convenience which creates an instance of the BatchGetVpcEndpointRequest.Builder avoiding the need to create one manually via BatchGetVpcEndpointRequest.builder()

      Parameters:
      batchGetVpcEndpointRequest - A Consumer that will call methods on BatchGetVpcEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetVpcEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessPolicy

      default CompletableFuture<CreateAccessPolicyResponse> createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)

      Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.

      Parameters:
      createAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the CreateAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAccessPolicy

      default CompletableFuture<CreateAccessPolicyResponse> createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest)

      Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the CreateAccessPolicyRequest.Builder avoiding the need to create one manually via CreateAccessPolicyRequest.builder()

      Parameters:
      createAccessPolicyRequest - A Consumer that will call methods on CreateAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCollection

      default CompletableFuture<CreateCollectionResponse> createCollection(CreateCollectionRequest createCollectionRequest)

      Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

      Parameters:
      createCollectionRequest -
      Returns:
      A Java Future containing the result of the CreateCollection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OcuLimitExceededException Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCollection

      default CompletableFuture<CreateCollectionResponse> createCollection(Consumer<CreateCollectionRequest.Builder> createCollectionRequest)

      Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.


      This is a convenience which creates an instance of the CreateCollectionRequest.Builder avoiding the need to create one manually via CreateCollectionRequest.builder()

      Parameters:
      createCollectionRequest - A Consumer that will call methods on CreateCollectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCollection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • OcuLimitExceededException Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLifecyclePolicy

      default CompletableFuture<CreateLifecyclePolicyResponse> createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)

      Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.

      Parameters:
      createLifecyclePolicyRequest -
      Returns:
      A Java Future containing the result of the CreateLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLifecyclePolicy

      default CompletableFuture<CreateLifecyclePolicyResponse> createLifecyclePolicy(Consumer<CreateLifecyclePolicyRequest.Builder> createLifecyclePolicyRequest)

      Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.


      This is a convenience which creates an instance of the CreateLifecyclePolicyRequest.Builder avoiding the need to create one manually via CreateLifecyclePolicyRequest.builder()

      Parameters:
      createLifecyclePolicyRequest - A Consumer that will call methods on CreateLifecyclePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSecurityConfig

      default CompletableFuture<CreateSecurityConfigResponse> createSecurityConfig(CreateSecurityConfigRequest createSecurityConfigRequest)

      Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

      Parameters:
      createSecurityConfigRequest -
      Returns:
      A Java Future containing the result of the CreateSecurityConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSecurityConfig

      default CompletableFuture<CreateSecurityConfigResponse> createSecurityConfig(Consumer<CreateSecurityConfigRequest.Builder> createSecurityConfigRequest)

      Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the CreateSecurityConfigRequest.Builder avoiding the need to create one manually via CreateSecurityConfigRequest.builder()

      Parameters:
      createSecurityConfigRequest - A Consumer that will call methods on CreateSecurityConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSecurityConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSecurityPolicy

      default CompletableFuture<CreateSecurityPolicyResponse> createSecurityPolicy(CreateSecurityPolicyRequest createSecurityPolicyRequest)

      Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

      Parameters:
      createSecurityPolicyRequest -
      Returns:
      A Java Future containing the result of the CreateSecurityPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSecurityPolicy

      default CompletableFuture<CreateSecurityPolicyResponse> createSecurityPolicy(Consumer<CreateSecurityPolicyRequest.Builder> createSecurityPolicyRequest)

      Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the CreateSecurityPolicyRequest.Builder avoiding the need to create one manually via CreateSecurityPolicyRequest.builder()

      Parameters:
      createSecurityPolicyRequest - A Consumer that will call methods on CreateSecurityPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSecurityPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVpcEndpoint

      default CompletableFuture<CreateVpcEndpointResponse> createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)

      Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

      Parameters:
      createVpcEndpointRequest -
      Returns:
      A Java Future containing the result of the CreateVpcEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVpcEndpoint

      default CompletableFuture<CreateVpcEndpointResponse> createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)

      Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.


      This is a convenience which creates an instance of the CreateVpcEndpointRequest.Builder avoiding the need to create one manually via CreateVpcEndpointRequest.builder()

      Parameters:
      createVpcEndpointRequest - A Consumer that will call methods on CreateVpcEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateVpcEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPolicy

      default CompletableFuture<DeleteAccessPolicyResponse> deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)

      Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

      Parameters:
      deleteAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAccessPolicy

      default CompletableFuture<DeleteAccessPolicyResponse> deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest)

      Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the DeleteAccessPolicyRequest.Builder avoiding the need to create one manually via DeleteAccessPolicyRequest.builder()

      Parameters:
      deleteAccessPolicyRequest - A Consumer that will call methods on DeleteAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCollection

      default CompletableFuture<DeleteCollectionResponse> deleteCollection(DeleteCollectionRequest deleteCollectionRequest)

      Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

      Parameters:
      deleteCollectionRequest -
      Returns:
      A Java Future containing the result of the DeleteCollection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCollection

      default CompletableFuture<DeleteCollectionResponse> deleteCollection(Consumer<DeleteCollectionRequest.Builder> deleteCollectionRequest)

      Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.


      This is a convenience which creates an instance of the DeleteCollectionRequest.Builder avoiding the need to create one manually via DeleteCollectionRequest.builder()

      Parameters:
      deleteCollectionRequest - A Consumer that will call methods on DeleteCollectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCollection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLifecyclePolicy

      default CompletableFuture<DeleteLifecyclePolicyResponse> deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)

      Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.

      Parameters:
      deleteLifecyclePolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLifecyclePolicy

      default CompletableFuture<DeleteLifecyclePolicyResponse> deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)

      Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.


      This is a convenience which creates an instance of the DeleteLifecyclePolicyRequest.Builder avoiding the need to create one manually via DeleteLifecyclePolicyRequest.builder()

      Parameters:
      deleteLifecyclePolicyRequest - A Consumer that will call methods on DeleteLifecyclePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSecurityConfig

      default CompletableFuture<DeleteSecurityConfigResponse> deleteSecurityConfig(DeleteSecurityConfigRequest deleteSecurityConfigRequest)

      Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

      Parameters:
      deleteSecurityConfigRequest -
      Returns:
      A Java Future containing the result of the DeleteSecurityConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSecurityConfig

      default CompletableFuture<DeleteSecurityConfigResponse> deleteSecurityConfig(Consumer<DeleteSecurityConfigRequest.Builder> deleteSecurityConfigRequest)

      Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the DeleteSecurityConfigRequest.Builder avoiding the need to create one manually via DeleteSecurityConfigRequest.builder()

      Parameters:
      deleteSecurityConfigRequest - A Consumer that will call methods on DeleteSecurityConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSecurityConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSecurityPolicy

      default CompletableFuture<DeleteSecurityPolicyResponse> deleteSecurityPolicy(DeleteSecurityPolicyRequest deleteSecurityPolicyRequest)

      Deletes an OpenSearch Serverless security policy.

      Parameters:
      deleteSecurityPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteSecurityPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSecurityPolicy

      default CompletableFuture<DeleteSecurityPolicyResponse> deleteSecurityPolicy(Consumer<DeleteSecurityPolicyRequest.Builder> deleteSecurityPolicyRequest)

      Deletes an OpenSearch Serverless security policy.


      This is a convenience which creates an instance of the DeleteSecurityPolicyRequest.Builder avoiding the need to create one manually via DeleteSecurityPolicyRequest.builder()

      Parameters:
      deleteSecurityPolicyRequest - A Consumer that will call methods on DeleteSecurityPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSecurityPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVpcEndpoint

      default CompletableFuture<DeleteVpcEndpointResponse> deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)

      Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

      Parameters:
      deleteVpcEndpointRequest -
      Returns:
      A Java Future containing the result of the DeleteVpcEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVpcEndpoint

      default CompletableFuture<DeleteVpcEndpointResponse> deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)

      Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.


      This is a convenience which creates an instance of the DeleteVpcEndpointRequest.Builder avoiding the need to create one manually via DeleteVpcEndpointRequest.builder()

      Parameters:
      deleteVpcEndpointRequest - A Consumer that will call methods on DeleteVpcEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteVpcEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPolicy

      default CompletableFuture<GetAccessPolicyResponse> getAccessPolicy(GetAccessPolicyRequest getAccessPolicyRequest)

      Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

      Parameters:
      getAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the GetAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccessPolicy

      default CompletableFuture<GetAccessPolicyResponse> getAccessPolicy(Consumer<GetAccessPolicyRequest.Builder> getAccessPolicyRequest)

      Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the GetAccessPolicyRequest.Builder avoiding the need to create one manually via GetAccessPolicyRequest.builder()

      Parameters:
      getAccessPolicyRequest - A Consumer that will call methods on GetAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccountSettings

      default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)

      Returns account-level settings related to OpenSearch Serverless.

      Parameters:
      getAccountSettingsRequest -
      Returns:
      A Java Future containing the result of the GetAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccountSettings

      default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)

      Returns account-level settings related to OpenSearch Serverless.


      This is a convenience which creates an instance of the GetAccountSettingsRequest.Builder avoiding the need to create one manually via GetAccountSettingsRequest.builder()

      Parameters:
      getAccountSettingsRequest - A Consumer that will call methods on GetAccountSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPoliciesStats

      default CompletableFuture<GetPoliciesStatsResponse> getPoliciesStats(GetPoliciesStatsRequest getPoliciesStatsRequest)

      Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

      Parameters:
      getPoliciesStatsRequest -
      Returns:
      A Java Future containing the result of the GetPoliciesStats operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPoliciesStats

      default CompletableFuture<GetPoliciesStatsResponse> getPoliciesStats(Consumer<GetPoliciesStatsRequest.Builder> getPoliciesStatsRequest)

      Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.


      This is a convenience which creates an instance of the GetPoliciesStatsRequest.Builder avoiding the need to create one manually via GetPoliciesStatsRequest.builder()

      Parameters:
      getPoliciesStatsRequest - A Consumer that will call methods on GetPoliciesStatsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPoliciesStats operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSecurityConfig

      default CompletableFuture<GetSecurityConfigResponse> getSecurityConfig(GetSecurityConfigRequest getSecurityConfigRequest)

      Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.

      Parameters:
      getSecurityConfigRequest -
      Returns:
      A Java Future containing the result of the GetSecurityConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSecurityConfig

      default CompletableFuture<GetSecurityConfigResponse> getSecurityConfig(Consumer<GetSecurityConfigRequest.Builder> getSecurityConfigRequest)

      Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the GetSecurityConfigRequest.Builder avoiding the need to create one manually via GetSecurityConfigRequest.builder()

      Parameters:
      getSecurityConfigRequest - A Consumer that will call methods on GetSecurityConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSecurityConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSecurityPolicy

      default CompletableFuture<GetSecurityPolicyResponse> getSecurityPolicy(GetSecurityPolicyRequest getSecurityPolicyRequest)

      Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

      Parameters:
      getSecurityPolicyRequest -
      Returns:
      A Java Future containing the result of the GetSecurityPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSecurityPolicy

      default CompletableFuture<GetSecurityPolicyResponse> getSecurityPolicy(Consumer<GetSecurityPolicyRequest.Builder> getSecurityPolicyRequest)

      Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the GetSecurityPolicyRequest.Builder avoiding the need to create one manually via GetSecurityPolicyRequest.builder()

      Parameters:
      getSecurityPolicyRequest - A Consumer that will call methods on GetSecurityPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSecurityPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPolicies

      default CompletableFuture<ListAccessPoliciesResponse> listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)

      Returns information about a list of OpenSearch Serverless access policies.

      Parameters:
      listAccessPoliciesRequest -
      Returns:
      A Java Future containing the result of the ListAccessPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPolicies

      default CompletableFuture<ListAccessPoliciesResponse> listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)

      Returns information about a list of OpenSearch Serverless access policies.


      This is a convenience which creates an instance of the ListAccessPoliciesRequest.Builder avoiding the need to create one manually via ListAccessPoliciesRequest.builder()

      Parameters:
      listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccessPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPoliciesPaginator

      default ListAccessPoliciesPublisher listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)

      This is a variant of listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest) operation.

      Parameters:
      listAccessPoliciesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAccessPoliciesPaginator

      default ListAccessPoliciesPublisher listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)

      This is a variant of listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest) operation.


      This is a convenience which creates an instance of the ListAccessPoliciesRequest.Builder avoiding the need to create one manually via ListAccessPoliciesRequest.builder()

      Parameters:
      listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCollections

      default CompletableFuture<ListCollectionsResponse> listCollections(ListCollectionsRequest listCollectionsRequest)

      Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

      Make sure to include an empty request body {} if you don't include any collection filters in the request.

      Parameters:
      listCollectionsRequest -
      Returns:
      A Java Future containing the result of the ListCollections operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCollections

      default CompletableFuture<ListCollectionsResponse> listCollections(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)

      Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

      Make sure to include an empty request body {} if you don't include any collection filters in the request.


      This is a convenience which creates an instance of the ListCollectionsRequest.Builder avoiding the need to create one manually via ListCollectionsRequest.builder()

      Parameters:
      listCollectionsRequest - A Consumer that will call methods on ListCollectionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCollections operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCollectionsPaginator

      default ListCollectionsPublisher listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)

      This is a variant of listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsPublisher publisher = client.listCollectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsPublisher publisher = client.listCollectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest) operation.

      Parameters:
      listCollectionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCollectionsPaginator

      default ListCollectionsPublisher listCollectionsPaginator(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)

      This is a variant of listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsPublisher publisher = client.listCollectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsPublisher publisher = client.listCollectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest) operation.


      This is a convenience which creates an instance of the ListCollectionsRequest.Builder avoiding the need to create one manually via ListCollectionsRequest.builder()

      Parameters:
      listCollectionsRequest - A Consumer that will call methods on ListCollectionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecyclePolicies

      default CompletableFuture<ListLifecyclePoliciesResponse> listLifecyclePolicies(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)

      Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

      Parameters:
      listLifecyclePoliciesRequest -
      Returns:
      A Java Future containing the result of the ListLifecyclePolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecyclePolicies

      default CompletableFuture<ListLifecyclePoliciesResponse> listLifecyclePolicies(Consumer<ListLifecyclePoliciesRequest.Builder> listLifecyclePoliciesRequest)

      Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.


      This is a convenience which creates an instance of the ListLifecyclePoliciesRequest.Builder avoiding the need to create one manually via ListLifecyclePoliciesRequest.builder()

      Parameters:
      listLifecyclePoliciesRequest - A Consumer that will call methods on ListLifecyclePoliciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLifecyclePolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecyclePoliciesPaginator

      default ListLifecyclePoliciesPublisher listLifecyclePoliciesPaginator(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)

      This is a variant of listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesPublisher publisher = client.listLifecyclePoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesPublisher publisher = client.listLifecyclePoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest) operation.

      Parameters:
      listLifecyclePoliciesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLifecyclePoliciesPaginator

      default ListLifecyclePoliciesPublisher listLifecyclePoliciesPaginator(Consumer<ListLifecyclePoliciesRequest.Builder> listLifecyclePoliciesRequest)

      This is a variant of listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesPublisher publisher = client.listLifecyclePoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesPublisher publisher = client.listLifecyclePoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest) operation.


      This is a convenience which creates an instance of the ListLifecyclePoliciesRequest.Builder avoiding the need to create one manually via ListLifecyclePoliciesRequest.builder()

      Parameters:
      listLifecyclePoliciesRequest - A Consumer that will call methods on ListLifecyclePoliciesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityConfigs

      default CompletableFuture<ListSecurityConfigsResponse> listSecurityConfigs(ListSecurityConfigsRequest listSecurityConfigsRequest)

      Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.

      Parameters:
      listSecurityConfigsRequest -
      Returns:
      A Java Future containing the result of the ListSecurityConfigs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityConfigs

      default CompletableFuture<ListSecurityConfigsResponse> listSecurityConfigs(Consumer<ListSecurityConfigsRequest.Builder> listSecurityConfigsRequest)

      Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the ListSecurityConfigsRequest.Builder avoiding the need to create one manually via ListSecurityConfigsRequest.builder()

      Parameters:
      listSecurityConfigsRequest - A Consumer that will call methods on ListSecurityConfigsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSecurityConfigs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityConfigsPaginator

      default ListSecurityConfigsPublisher listSecurityConfigsPaginator(ListSecurityConfigsRequest listSecurityConfigsRequest)

      This is a variant of listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsPublisher publisher = client.listSecurityConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsPublisher publisher = client.listSecurityConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest) operation.

      Parameters:
      listSecurityConfigsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityConfigsPaginator

      default ListSecurityConfigsPublisher listSecurityConfigsPaginator(Consumer<ListSecurityConfigsRequest.Builder> listSecurityConfigsRequest)

      This is a variant of listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsPublisher publisher = client.listSecurityConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsPublisher publisher = client.listSecurityConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest) operation.


      This is a convenience which creates an instance of the ListSecurityConfigsRequest.Builder avoiding the need to create one manually via ListSecurityConfigsRequest.builder()

      Parameters:
      listSecurityConfigsRequest - A Consumer that will call methods on ListSecurityConfigsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityPolicies

      default CompletableFuture<ListSecurityPoliciesResponse> listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)

      Returns information about configured OpenSearch Serverless security policies.

      Parameters:
      listSecurityPoliciesRequest -
      Returns:
      A Java Future containing the result of the ListSecurityPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityPolicies

      default CompletableFuture<ListSecurityPoliciesResponse> listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)

      Returns information about configured OpenSearch Serverless security policies.


      This is a convenience which creates an instance of the ListSecurityPoliciesRequest.Builder avoiding the need to create one manually via ListSecurityPoliciesRequest.builder()

      Parameters:
      listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSecurityPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityPoliciesPaginator

      default ListSecurityPoliciesPublisher listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)

      This is a variant of listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest) operation.

      Parameters:
      listSecurityPoliciesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityPoliciesPaginator

      default ListSecurityPoliciesPublisher listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)

      This is a variant of listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest) operation.


      This is a convenience which creates an instance of the ListSecurityPoliciesRequest.Builder avoiding the need to create one manually via ListSecurityPoliciesRequest.builder()

      Parameters:
      listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVpcEndpoints

      default CompletableFuture<ListVpcEndpointsResponse> listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)

      Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

      Parameters:
      listVpcEndpointsRequest -
      Returns:
      A Java Future containing the result of the ListVpcEndpoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVpcEndpoints

      default CompletableFuture<ListVpcEndpointsResponse> listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)

      Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.


      This is a convenience which creates an instance of the ListVpcEndpointsRequest.Builder avoiding the need to create one manually via ListVpcEndpointsRequest.builder()

      Parameters:
      listVpcEndpointsRequest - A Consumer that will call methods on ListVpcEndpointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListVpcEndpoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVpcEndpointsPaginator

      default ListVpcEndpointsPublisher listVpcEndpointsPaginator(ListVpcEndpointsRequest listVpcEndpointsRequest)

      This is a variant of listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsPublisher publisher = client.listVpcEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsPublisher publisher = client.listVpcEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest) operation.

      Parameters:
      listVpcEndpointsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVpcEndpointsPaginator

      default ListVpcEndpointsPublisher listVpcEndpointsPaginator(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)

      This is a variant of listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsPublisher publisher = client.listVpcEndpointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsPublisher publisher = client.listVpcEndpointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest) operation.


      This is a convenience which creates an instance of the ListVpcEndpointsRequest.Builder avoiding the need to create one manually via ListVpcEndpointsRequest.builder()

      Parameters:
      listVpcEndpointsRequest - A Consumer that will call methods on ListVpcEndpointsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccessPolicy

      default CompletableFuture<UpdateAccessPolicyResponse> updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)

      Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

      Parameters:
      updateAccessPolicyRequest -
      Returns:
      A Java Future containing the result of the UpdateAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccessPolicy

      default CompletableFuture<UpdateAccessPolicyResponse> updateAccessPolicy(Consumer<UpdateAccessPolicyRequest.Builder> updateAccessPolicyRequest)

      Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the UpdateAccessPolicyRequest.Builder avoiding the need to create one manually via UpdateAccessPolicyRequest.builder()

      Parameters:
      updateAccessPolicyRequest - A Consumer that will call methods on UpdateAccessPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAccessPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccountSettings

      default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)

      Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

      Parameters:
      updateAccountSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccountSettings

      default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)

      Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the UpdateAccountSettingsRequest.Builder avoiding the need to create one manually via UpdateAccountSettingsRequest.builder()

      Parameters:
      updateAccountSettingsRequest - A Consumer that will call methods on UpdateAccountSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCollection

      default CompletableFuture<UpdateCollectionResponse> updateCollection(UpdateCollectionRequest updateCollectionRequest)

      Updates an OpenSearch Serverless collection.

      Parameters:
      updateCollectionRequest -
      Returns:
      A Java Future containing the result of the UpdateCollection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCollection

      default CompletableFuture<UpdateCollectionResponse> updateCollection(Consumer<UpdateCollectionRequest.Builder> updateCollectionRequest)

      Updates an OpenSearch Serverless collection.


      This is a convenience which creates an instance of the UpdateCollectionRequest.Builder avoiding the need to create one manually via UpdateCollectionRequest.builder()

      Parameters:
      updateCollectionRequest - A Consumer that will call methods on UpdateCollectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCollection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLifecyclePolicy

      default CompletableFuture<UpdateLifecyclePolicyResponse> updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest)

      Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.

      Parameters:
      updateLifecyclePolicyRequest -
      Returns:
      A Java Future containing the result of the UpdateLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLifecyclePolicy

      default CompletableFuture<UpdateLifecyclePolicyResponse> updateLifecyclePolicy(Consumer<UpdateLifecyclePolicyRequest.Builder> updateLifecyclePolicyRequest)

      Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.


      This is a convenience which creates an instance of the UpdateLifecyclePolicyRequest.Builder avoiding the need to create one manually via UpdateLifecyclePolicyRequest.builder()

      Parameters:
      updateLifecyclePolicyRequest - A Consumer that will call methods on UpdateLifecyclePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLifecyclePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSecurityConfig

      default CompletableFuture<UpdateSecurityConfigResponse> updateSecurityConfig(UpdateSecurityConfigRequest updateSecurityConfigRequest)

      Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

      Parameters:
      updateSecurityConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateSecurityConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSecurityConfig

      default CompletableFuture<UpdateSecurityConfigResponse> updateSecurityConfig(Consumer<UpdateSecurityConfigRequest.Builder> updateSecurityConfigRequest)

      Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the UpdateSecurityConfigRequest.Builder avoiding the need to create one manually via UpdateSecurityConfigRequest.builder()

      Parameters:
      updateSecurityConfigRequest - A Consumer that will call methods on UpdateSecurityConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSecurityConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSecurityPolicy

      default CompletableFuture<UpdateSecurityPolicyResponse> updateSecurityPolicy(UpdateSecurityPolicyRequest updateSecurityPolicyRequest)

      Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

      Parameters:
      updateSecurityPolicyRequest -
      Returns:
      A Java Future containing the result of the UpdateSecurityPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSecurityPolicy

      default CompletableFuture<UpdateSecurityPolicyResponse> updateSecurityPolicy(Consumer<UpdateSecurityPolicyRequest.Builder> updateSecurityPolicyRequest)

      Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.


      This is a convenience which creates an instance of the UpdateSecurityPolicyRequest.Builder avoiding the need to create one manually via UpdateSecurityPolicyRequest.builder()

      Parameters:
      updateSecurityPolicyRequest - A Consumer that will call methods on UpdateSecurityPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSecurityPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ResourceNotFoundException Thrown when accessing or deleting a resource that does not exist.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • ServiceQuotaExceededException Thrown when you attempt to create more resources than the service allows based on service quotas.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateVpcEndpoint

      default CompletableFuture<UpdateVpcEndpointResponse> updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)

      Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

      Parameters:
      updateVpcEndpointRequest -
      Returns:
      A Java Future containing the result of the UpdateVpcEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateVpcEndpoint

      default CompletableFuture<UpdateVpcEndpointResponse> updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)

      Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.


      This is a convenience which creates an instance of the UpdateVpcEndpointRequest.Builder avoiding the need to create one manually via UpdateVpcEndpointRequest.builder()

      Parameters:
      updateVpcEndpointRequest - A Consumer that will call methods on UpdateVpcEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateVpcEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Thrown when an error internal to the service occurs while processing a request.
      • ConflictException When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
      • ValidationException Thrown when the HTTP request contains invalid input or is missing required input.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • OpenSearchServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default OpenSearchServerlessServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static OpenSearchServerlessAsyncClient create()
      Create a OpenSearchServerlessAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static OpenSearchServerlessAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a OpenSearchServerlessAsyncClient.