Package software.amazon.awssdk.services.osis

Interface OsisAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface OsisAsyncClient extends AwsClient
Service client for accessing Amazon OpenSearch Ingestion 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 Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see Getting data into your cluster using OpenSearch Ingestion.

  • Field Details

  • Method Details

    • createPipeline

      default CompletableFuture<CreatePipelineResponse> createPipeline(CreatePipelineRequest createPipelineRequest)

      Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

      Parameters:
      createPipelineRequest -
      Returns:
      A Java Future containing the result of the CreatePipeline 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.
      • LimitExceededException You attempted to create more than the allowed number of tags.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceAlreadyExistsException You attempted to create a resource that already exists.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPipeline

      default CompletableFuture<CreatePipelineResponse> createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)

      Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.


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

      Parameters:
      createPipelineRequest - A Consumer that will call methods on CreatePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePipeline 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.
      • LimitExceededException You attempted to create more than the allowed number of tags.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceAlreadyExistsException You attempted to create a resource that already exists.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePipeline

      default CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest deletePipelineRequest)

      Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.

      Parameters:
      deletePipelineRequest -
      Returns:
      A Java Future containing the result of the DeletePipeline 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • ConflictException The client attempted to remove a resource that is currently in use.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePipeline

      default CompletableFuture<DeletePipelineResponse> deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)

      Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.


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

      Parameters:
      deletePipelineRequest - A Consumer that will call methods on DeletePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePipeline 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • ConflictException The client attempted to remove a resource that is currently in use.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPipeline

      default CompletableFuture<GetPipelineResponse> getPipeline(GetPipelineRequest getPipelineRequest)

      Retrieves information about an OpenSearch Ingestion pipeline.

      Parameters:
      getPipelineRequest -
      Returns:
      A Java Future containing the result of the GetPipeline 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPipeline

      default CompletableFuture<GetPipelineResponse> getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest)

      Retrieves information about an OpenSearch Ingestion pipeline.


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

      Parameters:
      getPipelineRequest - A Consumer that will call methods on GetPipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPipeline 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPipelineBlueprint

      default CompletableFuture<GetPipelineBlueprintResponse> getPipelineBlueprint(GetPipelineBlueprintRequest getPipelineBlueprintRequest)

      Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.

      Parameters:
      getPipelineBlueprintRequest -
      Returns:
      A Java Future containing the result of the GetPipelineBlueprint 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.
      • AccessDeniedException You don't have permissions to access the resource.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • ValidationException An exception for missing or invalid input fields.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPipelineBlueprint

      default CompletableFuture<GetPipelineBlueprintResponse> getPipelineBlueprint(Consumer<GetPipelineBlueprintRequest.Builder> getPipelineBlueprintRequest)

      Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.


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

      Parameters:
      getPipelineBlueprintRequest - A Consumer that will call methods on GetPipelineBlueprintRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPipelineBlueprint 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.
      • AccessDeniedException You don't have permissions to access the resource.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • ValidationException An exception for missing or invalid input fields.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPipelineChangeProgress

      default CompletableFuture<GetPipelineChangeProgressResponse> getPipelineChangeProgress(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest)

      Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.

      For more information, see Tracking the status of pipeline creation.

      Parameters:
      getPipelineChangeProgressRequest -
      Returns:
      A Java Future containing the result of the GetPipelineChangeProgress 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPipelineChangeProgress

      default CompletableFuture<GetPipelineChangeProgressResponse> getPipelineChangeProgress(Consumer<GetPipelineChangeProgressRequest.Builder> getPipelineChangeProgressRequest)

      Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.

      For more information, see Tracking the status of pipeline creation.


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

      Parameters:
      getPipelineChangeProgressRequest - A Consumer that will call methods on GetPipelineChangeProgressRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPipelineChangeProgress 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineBlueprints

      default CompletableFuture<ListPipelineBlueprintsResponse> listPipelineBlueprints(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest)

      Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.

      Parameters:
      listPipelineBlueprintsRequest -
      Returns:
      A Java Future containing the result of the ListPipelineBlueprints 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • InvalidPaginationTokenException An invalid pagination token provided in the 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelineBlueprints

      default CompletableFuture<ListPipelineBlueprintsResponse> listPipelineBlueprints(Consumer<ListPipelineBlueprintsRequest.Builder> listPipelineBlueprintsRequest)

      Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.


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

      Parameters:
      listPipelineBlueprintsRequest - A Consumer that will call methods on ListPipelineBlueprintsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPipelineBlueprints 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • InvalidPaginationTokenException An invalid pagination token provided in the 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelines

      default CompletableFuture<ListPipelinesResponse> listPipelines(ListPipelinesRequest listPipelinesRequest)

      Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

      Parameters:
      listPipelinesRequest -
      Returns:
      A Java Future containing the result of the ListPipelines 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • InvalidPaginationTokenException An invalid pagination token provided in the 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelines

      default CompletableFuture<ListPipelinesResponse> listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)

      Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.


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

      Parameters:
      listPipelinesRequest - A Consumer that will call methods on ListPipelinesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPipelines 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • InvalidPaginationTokenException An invalid pagination token provided in the 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelinesPaginator

      default ListPipelinesPublisher listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)

      This is a variant of listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) 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.osis.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.osis.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.osis.model.ListPipelinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.osis.model.ListPipelinesResponse 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 listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) operation.

      Parameters:
      listPipelinesRequest -
      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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • InvalidPaginationTokenException An invalid pagination token provided in the 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipelinesPaginator

      default ListPipelinesPublisher listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)

      This is a variant of listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) 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.osis.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.osis.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.osis.model.ListPipelinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.osis.model.ListPipelinesResponse 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 listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) operation.


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

      Parameters:
      listPipelinesRequest - A Consumer that will call methods on ListPipelinesRequest.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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • InvalidPaginationTokenException An invalid pagination token provided in the 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.
      • OsisException 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)

      Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

      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.
      • ValidationException An exception for missing or invalid input fields.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • 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.
      • OsisException 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)

      Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.


      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.
      • ValidationException An exception for missing or invalid input fields.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startPipeline

      default CompletableFuture<StartPipelineResponse> startPipeline(StartPipelineRequest startPipelineRequest)

      Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.

      Parameters:
      startPipelineRequest -
      Returns:
      A Java Future containing the result of the StartPipeline 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.
      • AccessDeniedException You don't have permissions to access the resource.
      • ConflictException The client attempted to remove a resource that is currently in use.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • ValidationException An exception for missing or invalid input fields.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startPipeline

      default CompletableFuture<StartPipelineResponse> startPipeline(Consumer<StartPipelineRequest.Builder> startPipelineRequest)

      Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.


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

      Parameters:
      startPipelineRequest - A Consumer that will call methods on StartPipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartPipeline 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.
      • AccessDeniedException You don't have permissions to access the resource.
      • ConflictException The client attempted to remove a resource that is currently in use.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • ValidationException An exception for missing or invalid input fields.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopPipeline

      default CompletableFuture<StopPipelineResponse> stopPipeline(StopPipelineRequest stopPipelineRequest)

      Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.

      Parameters:
      stopPipelineRequest -
      Returns:
      A Java Future containing the result of the StopPipeline 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.
      • AccessDeniedException You don't have permissions to access the resource.
      • ConflictException The client attempted to remove a resource that is currently in use.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • ValidationException An exception for missing or invalid input fields.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopPipeline

      default CompletableFuture<StopPipelineResponse> stopPipeline(Consumer<StopPipelineRequest.Builder> stopPipelineRequest)

      Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.


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

      Parameters:
      stopPipelineRequest - A Consumer that will call methods on StopPipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopPipeline 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.
      • AccessDeniedException You don't have permissions to access the resource.
      • ConflictException The client attempted to remove a resource that is currently in use.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • ValidationException An exception for missing or invalid input fields.
      • 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.
      • OsisException 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)

      Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

      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.
      • LimitExceededException You attempted to create more than the allowed number of tags.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • 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.
      • OsisException 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)

      Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.


      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.
      • LimitExceededException You attempted to create more than the allowed number of tags.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • 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.
      • OsisException 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 one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

      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.
      • ValidationException An exception for missing or invalid input fields.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • 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.
      • OsisException 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 one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.


      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.
      • ValidationException An exception for missing or invalid input fields.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePipeline

      default CompletableFuture<UpdatePipelineResponse> updatePipeline(UpdatePipelineRequest updatePipelineRequest)

      Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.

      Parameters:
      updatePipelineRequest -
      Returns:
      A Java Future containing the result of the UpdatePipeline 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • ConflictException The client attempted to remove a resource that is currently in use.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePipeline

      default CompletableFuture<UpdatePipelineResponse> updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)

      Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.


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

      Parameters:
      updatePipelineRequest - A Consumer that will call methods on UpdatePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePipeline 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.
      • ValidationException An exception for missing or invalid input fields.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • AccessDeniedException You don't have permissions to access the resource.
      • ResourceNotFoundException You attempted to access or delete a resource that does not exist.
      • ConflictException The client attempted to remove a resource that is currently in use.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • validatePipeline

      default CompletableFuture<ValidatePipelineResponse> validatePipeline(ValidatePipelineRequest validatePipelineRequest)

      Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

      Parameters:
      validatePipelineRequest -
      Returns:
      A Java Future containing the result of the ValidatePipeline 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.
      • AccessDeniedException You don't have permissions to access the resource.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • ValidationException An exception for missing or invalid input fields.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • validatePipeline

      default CompletableFuture<ValidatePipelineResponse> validatePipeline(Consumer<ValidatePipelineRequest.Builder> validatePipelineRequest)

      Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.


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

      Parameters:
      validatePipelineRequest - A Consumer that will call methods on ValidatePipelineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ValidatePipeline 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.
      • AccessDeniedException You don't have permissions to access the resource.
      • InternalException The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
      • ValidationException An exception for missing or invalid input fields.
      • 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.
      • OsisException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default OsisServiceClientConfiguration 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 OsisAsyncClient create()
      Create a OsisAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static OsisAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a OsisAsyncClient.