com.amazonaws.services.osis

Interface AmazonOSISAsync

All Superinterfaces:

AmazonOSIS

All Known Implementing Classes:

AbstractAmazonOSISAsync, AmazonOSISAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonOSISAsync
extends AmazonOSIS

Interface for accessing Amazon OpenSearch Ingestion asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonOSISAsync instead.

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 Summary

Fields inherited from interface com.amazonaws.services.osis.AmazonOSIS

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<CreatePipelineResult>	createPipelineAsync(CreatePipelineRequest createPipelineRequest) Creates an OpenSearch Ingestion pipeline.
Future<CreatePipelineResult>	createPipelineAsync(CreatePipelineRequest createPipelineRequest, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler) Creates an OpenSearch Ingestion pipeline.
Future<DeletePipelineResult>	deletePipelineAsync(DeletePipelineRequest deletePipelineRequest) Deletes an OpenSearch Ingestion pipeline.
Future<DeletePipelineResult>	deletePipelineAsync(DeletePipelineRequest deletePipelineRequest, AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler) Deletes an OpenSearch Ingestion pipeline.
Future<GetPipelineResult>	getPipelineAsync(GetPipelineRequest getPipelineRequest) Retrieves information about an OpenSearch Ingestion pipeline.
Future<GetPipelineResult>	getPipelineAsync(GetPipelineRequest getPipelineRequest, AsyncHandler<GetPipelineRequest,GetPipelineResult> asyncHandler) Retrieves information about an OpenSearch Ingestion pipeline.
Future<GetPipelineBlueprintResult>	getPipelineBlueprintAsync(GetPipelineBlueprintRequest getPipelineBlueprintRequest) Retrieves information about a specific blueprint for OpenSearch Ingestion.
Future<GetPipelineBlueprintResult>	getPipelineBlueprintAsync(GetPipelineBlueprintRequest getPipelineBlueprintRequest, AsyncHandler<GetPipelineBlueprintRequest,GetPipelineBlueprintResult> asyncHandler) Retrieves information about a specific blueprint for OpenSearch Ingestion.
Future<GetPipelineChangeProgressResult>	getPipelineChangeProgressAsync(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest) Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
Future<GetPipelineChangeProgressResult>	getPipelineChangeProgressAsync(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest, AsyncHandler<GetPipelineChangeProgressRequest,GetPipelineChangeProgressResult> asyncHandler) Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
Future<ListPipelineBlueprintsResult>	listPipelineBlueprintsAsync(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest) Retrieves a list of all available blueprints for Data Prepper.
Future<ListPipelineBlueprintsResult>	listPipelineBlueprintsAsync(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest, AsyncHandler<ListPipelineBlueprintsRequest,ListPipelineBlueprintsResult> asyncHandler) Retrieves a list of all available blueprints for Data Prepper.
Future<ListPipelinesResult>	listPipelinesAsync(ListPipelinesRequest listPipelinesRequest) Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
Future<ListPipelinesResult>	listPipelinesAsync(ListPipelinesRequest listPipelinesRequest, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler) Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest) Lists all resource tags associated with an OpenSearch Ingestion pipeline.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Lists all resource tags associated with an OpenSearch Ingestion pipeline.
Future<StartPipelineResult>	startPipelineAsync(StartPipelineRequest startPipelineRequest) Starts an OpenSearch Ingestion pipeline.
Future<StartPipelineResult>	startPipelineAsync(StartPipelineRequest startPipelineRequest, AsyncHandler<StartPipelineRequest,StartPipelineResult> asyncHandler) Starts an OpenSearch Ingestion pipeline.
Future<StopPipelineResult>	stopPipelineAsync(StopPipelineRequest stopPipelineRequest) Stops an OpenSearch Ingestion pipeline.
Future<StopPipelineResult>	stopPipelineAsync(StopPipelineRequest stopPipelineRequest, AsyncHandler<StopPipelineRequest,StopPipelineResult> asyncHandler) Stops an OpenSearch Ingestion pipeline.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest) Tags an OpenSearch Ingestion pipeline.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Tags an OpenSearch Ingestion pipeline.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest) Removes one or more tags from an OpenSearch Ingestion pipeline.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes one or more tags from an OpenSearch Ingestion pipeline.
Future<UpdatePipelineResult>	updatePipelineAsync(UpdatePipelineRequest updatePipelineRequest) Updates an OpenSearch Ingestion pipeline.
Future<UpdatePipelineResult>	updatePipelineAsync(UpdatePipelineRequest updatePipelineRequest, AsyncHandler<UpdatePipelineRequest,UpdatePipelineResult> asyncHandler) Updates an OpenSearch Ingestion pipeline.
Future<ValidatePipelineResult>	validatePipelineAsync(ValidatePipelineRequest validatePipelineRequest) Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
Future<ValidatePipelineResult>	validatePipelineAsync(ValidatePipelineRequest validatePipelineRequest, AsyncHandler<ValidatePipelineRequest,ValidatePipelineResult> asyncHandler) Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.

Methods inherited from interface com.amazonaws.services.osis.AmazonOSIS

createPipeline, deletePipeline, getCachedResponseMetadata, getPipeline, getPipelineBlueprint, getPipelineChangeProgress, listPipelineBlueprints, listPipelines, listTagsForResource, shutdown, startPipeline, stopPipeline, tagResource, untagResource, updatePipeline, validatePipeline

Method Detail

createPipelineAsync

Future<CreatePipelineResult> createPipelineAsync(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.

See Also:

AWS API Documentation

createPipelineAsync

Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest createPipelineRequest,
                                                 AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)

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

Parameters:

createPipelineRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreatePipeline operation returned by the service.

See Also:

AWS API Documentation

deletePipelineAsync

Future<DeletePipelineResult> deletePipelineAsync(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.

See Also:

AWS API Documentation

deletePipelineAsync

Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest deletePipelineRequest,
                                                 AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)

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

Parameters:

deletePipelineRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeletePipeline operation returned by the service.

See Also:

AWS API Documentation

getPipelineAsync

Future<GetPipelineResult> getPipelineAsync(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.

See Also:

AWS API Documentation

getPipelineAsync

Future<GetPipelineResult> getPipelineAsync(GetPipelineRequest getPipelineRequest,
                                           AsyncHandler<GetPipelineRequest,GetPipelineResult> asyncHandler)

Retrieves information about an OpenSearch Ingestion pipeline.

Parameters:

getPipelineRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetPipeline operation returned by the service.

See Also:

AWS API Documentation

getPipelineBlueprintAsync

Future<GetPipelineBlueprintResult> getPipelineBlueprintAsync(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.

See Also:

AWS API Documentation

getPipelineBlueprintAsync

Future<GetPipelineBlueprintResult> getPipelineBlueprintAsync(GetPipelineBlueprintRequest getPipelineBlueprintRequest,
                                                             AsyncHandler<GetPipelineBlueprintRequest,GetPipelineBlueprintResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetPipelineBlueprint operation returned by the service.

See Also:

AWS API Documentation

getPipelineChangeProgressAsync

Future<GetPipelineChangeProgressResult> getPipelineChangeProgressAsync(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.

See Also:

AWS API Documentation

getPipelineChangeProgressAsync

Future<GetPipelineChangeProgressResult> getPipelineChangeProgressAsync(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest,
                                                                       AsyncHandler<GetPipelineChangeProgressRequest,GetPipelineChangeProgressResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetPipelineChangeProgress operation returned by the service.

See Also:

AWS API Documentation

listPipelineBlueprintsAsync

Future<ListPipelineBlueprintsResult> listPipelineBlueprintsAsync(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.

See Also:

AWS API Documentation

listPipelineBlueprintsAsync

Future<ListPipelineBlueprintsResult> listPipelineBlueprintsAsync(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest,
                                                                 AsyncHandler<ListPipelineBlueprintsRequest,ListPipelineBlueprintsResult> asyncHandler)

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

Parameters:

listPipelineBlueprintsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListPipelineBlueprints operation returned by the service.

See Also:

AWS API Documentation

listPipelinesAsync

Future<ListPipelinesResult> listPipelinesAsync(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.

See Also:

AWS API Documentation

listPipelinesAsync

Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest listPipelinesRequest,
                                               AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListPipelines operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(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.

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
                                                           AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

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

Parameters:

listTagsForResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

startPipelineAsync

Future<StartPipelineResult> startPipelineAsync(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.

See Also:

AWS API Documentation

startPipelineAsync

Future<StartPipelineResult> startPipelineAsync(StartPipelineRequest startPipelineRequest,
                                               AsyncHandler<StartPipelineRequest,StartPipelineResult> asyncHandler)

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

Parameters:

startPipelineRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StartPipeline operation returned by the service.

See Also:

AWS API Documentation

stopPipelineAsync

Future<StopPipelineResult> stopPipelineAsync(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.

See Also:

AWS API Documentation

stopPipelineAsync

Future<StopPipelineResult> stopPipelineAsync(StopPipelineRequest stopPipelineRequest,
                                             AsyncHandler<StopPipelineRequest,StopPipelineResult> asyncHandler)

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

Parameters:

stopPipelineRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StopPipeline operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(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.

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest,
                                           AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

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

Parameters:

tagResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(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.

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest,
                                               AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Parameters:

untagResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updatePipelineAsync

Future<UpdatePipelineResult> updatePipelineAsync(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.

See Also:

AWS API Documentation

updatePipelineAsync

Future<UpdatePipelineResult> updatePipelineAsync(UpdatePipelineRequest updatePipelineRequest,
                                                 AsyncHandler<UpdatePipelineRequest,UpdatePipelineResult> asyncHandler)

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

Parameters:

updatePipelineRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdatePipeline operation returned by the service.

See Also:

AWS API Documentation

validatePipelineAsync

Future<ValidatePipelineResult> validatePipelineAsync(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.

See Also:

AWS API Documentation

validatePipelineAsync

Future<ValidatePipelineResult> validatePipelineAsync(ValidatePipelineRequest validatePipelineRequest,
                                                     AsyncHandler<ValidatePipelineRequest,ValidatePipelineResult> asyncHandler)

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

Parameters:

validatePipelineRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ValidatePipeline operation returned by the service.

See Also:

AWS API Documentation