Interface OsisClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface OsisClient
extends AwsClient

Service client for accessing Amazon OpenSearch Ingestion. This can be created using the static builder() method.

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

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static OsisClientBuilder	builder()	Create a builder that can be used to configure and create a OsisClient.
static OsisClient	create()	Create a OsisClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreatePipelineResponse	createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)	Creates an OpenSearch Ingestion pipeline.
default CreatePipelineResponse	createPipeline(CreatePipelineRequest createPipelineRequest)	Creates an OpenSearch Ingestion pipeline.
default DeletePipelineResponse	deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)	Deletes an OpenSearch Ingestion pipeline.
default DeletePipelineResponse	deletePipeline(DeletePipelineRequest deletePipelineRequest)	Deletes an OpenSearch Ingestion pipeline.
default GetPipelineResponse	getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest)	Retrieves information about an OpenSearch Ingestion pipeline.
default GetPipelineResponse	getPipeline(GetPipelineRequest getPipelineRequest)	Retrieves information about an OpenSearch Ingestion pipeline.
default GetPipelineBlueprintResponse	getPipelineBlueprint(Consumer<GetPipelineBlueprintRequest.Builder> getPipelineBlueprintRequest)	Retrieves information about a specific blueprint for OpenSearch Ingestion.
default GetPipelineBlueprintResponse	getPipelineBlueprint(GetPipelineBlueprintRequest getPipelineBlueprintRequest)	Retrieves information about a specific blueprint for OpenSearch Ingestion.
default GetPipelineChangeProgressResponse	getPipelineChangeProgress(Consumer<GetPipelineChangeProgressRequest.Builder> getPipelineChangeProgressRequest)	Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
default GetPipelineChangeProgressResponse	getPipelineChangeProgress(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest)	Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
default ListPipelineBlueprintsResponse	listPipelineBlueprints(Consumer<ListPipelineBlueprintsRequest.Builder> listPipelineBlueprintsRequest)	Retrieves a list of all available blueprints for Data Prepper.
default ListPipelineBlueprintsResponse	listPipelineBlueprints(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest)	Retrieves a list of all available blueprints for Data Prepper.
default ListPipelinesResponse	listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)	Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
default ListPipelinesResponse	listPipelines(ListPipelinesRequest listPipelinesRequest)	Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
default ListPipelinesIterable	listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)	This is a variant of listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) operation.
default ListPipelinesIterable	listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)	This is a variant of listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all resource tags associated with an OpenSearch Ingestion pipeline.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all resource tags associated with an OpenSearch Ingestion pipeline.
default OsisServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartPipelineResponse	startPipeline(Consumer<StartPipelineRequest.Builder> startPipelineRequest)	Starts an OpenSearch Ingestion pipeline.
default StartPipelineResponse	startPipeline(StartPipelineRequest startPipelineRequest)	Starts an OpenSearch Ingestion pipeline.
default StopPipelineResponse	stopPipeline(Consumer<StopPipelineRequest.Builder> stopPipelineRequest)	Stops an OpenSearch Ingestion pipeline.
default StopPipelineResponse	stopPipeline(StopPipelineRequest stopPipelineRequest)	Stops an OpenSearch Ingestion pipeline.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Tags an OpenSearch Ingestion pipeline.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Tags an OpenSearch Ingestion pipeline.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from an OpenSearch Ingestion pipeline.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from an OpenSearch Ingestion pipeline.
default UpdatePipelineResponse	updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)	Updates an OpenSearch Ingestion pipeline.
default UpdatePipelineResponse	updatePipeline(UpdatePipelineRequest updatePipelineRequest)	Updates an OpenSearch Ingestion pipeline.
default ValidatePipelineResponse	validatePipeline(Consumer<ValidatePipelineRequest.Builder> validatePipelineRequest)	Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
default ValidatePipelineResponse	validatePipeline(ValidatePipelineRequest validatePipelineRequest)	Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createPipeline

default CreatePipelineResponse createPipeline(CreatePipelineRequest createPipelineRequest)
                                       throws DisabledOperationException,
LimitExceededException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
OsisException

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

Parameters:

createPipelineRequest -

Returns:

Result of the CreatePipeline operation returned by the service.

See Also:

• AWS API Documentation

createPipeline

default CreatePipelineResponse createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
                                       throws DisabledOperationException,
LimitExceededException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the CreatePipeline operation returned by the service.

See Also:

• AWS API Documentation

deletePipeline

default DeletePipelineResponse deletePipeline(DeletePipelineRequest deletePipelineRequest)
                                       throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
OsisException

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

Parameters:

deletePipelineRequest -

Returns:

Result of the DeletePipeline operation returned by the service.

See Also:

• AWS API Documentation

deletePipeline

default DeletePipelineResponse deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
                                       throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the DeletePipeline operation returned by the service.

See Also:

• AWS API Documentation

getPipeline

default GetPipelineResponse getPipeline(GetPipelineRequest getPipelineRequest)
                                 throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
OsisException

Retrieves information about an OpenSearch Ingestion pipeline.

Parameters:

getPipelineRequest -

Returns:

Result of the GetPipeline operation returned by the service.

See Also:

• AWS API Documentation

getPipeline

default GetPipelineResponse getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest)
                                 throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the GetPipeline operation returned by the service.

See Also:

• AWS API Documentation

getPipelineBlueprint

default GetPipelineBlueprintResponse getPipelineBlueprint(GetPipelineBlueprintRequest getPipelineBlueprintRequest)
                                                   throws DisabledOperationException,
AccessDeniedException,
InternalException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the GetPipelineBlueprint operation returned by the service.

See Also:

• AWS API Documentation

getPipelineBlueprint

default GetPipelineBlueprintResponse getPipelineBlueprint(Consumer<GetPipelineBlueprintRequest.Builder> getPipelineBlueprintRequest)
                                                   throws DisabledOperationException,
AccessDeniedException,
InternalException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the GetPipelineBlueprint operation returned by the service.

See Also:

• AWS API Documentation

getPipelineChangeProgress

default GetPipelineChangeProgressResponse getPipelineChangeProgress(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest)
                                                             throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the GetPipelineChangeProgress operation returned by the service.

See Also:

• AWS API Documentation

getPipelineChangeProgress

default GetPipelineChangeProgressResponse getPipelineChangeProgress(Consumer<GetPipelineChangeProgressRequest.Builder> getPipelineChangeProgressRequest)
                                                             throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the GetPipelineChangeProgress operation returned by the service.

See Also:

• AWS API Documentation

listPipelineBlueprints

default ListPipelineBlueprintsResponse listPipelineBlueprints(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest)
                                                       throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
InvalidPaginationTokenException,
AwsServiceException,
SdkClientException,
OsisException

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

Parameters:

listPipelineBlueprintsRequest -

Returns:

Result of the ListPipelineBlueprints operation returned by the service.

See Also:

• AWS API Documentation

listPipelineBlueprints

default ListPipelineBlueprintsResponse listPipelineBlueprints(Consumer<ListPipelineBlueprintsRequest.Builder> listPipelineBlueprintsRequest)
                                                       throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
InvalidPaginationTokenException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the ListPipelineBlueprints operation returned by the service.

See Also:

• AWS API Documentation

listPipelines

default ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest)
                                     throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
InvalidPaginationTokenException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the ListPipelines operation returned by the service.

See Also:

• AWS API Documentation

listPipelines

default ListPipelinesResponse listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
                                     throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
InvalidPaginationTokenException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the ListPipelines operation returned by the service.

See Also:

• AWS API Documentation

listPipelinesPaginator

default ListPipelinesIterable listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)
                                              throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
InvalidPaginationTokenException,
AwsServiceException,
SdkClientException,
OsisException

This is a variant of listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
     for (software.amazon.awssdk.services.osis.model.ListPipelinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPipelinesPaginator

default ListPipelinesIterable listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
                                              throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
InvalidPaginationTokenException,
AwsServiceException,
SdkClientException,
OsisException

This is a variant of listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
     for (software.amazon.awssdk.services.osis.model.ListPipelinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws DisabledOperationException,
ValidationException,
ResourceNotFoundException,
InternalException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
OsisException

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws DisabledOperationException,
ValidationException,
ResourceNotFoundException,
InternalException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

startPipeline

default StartPipelineResponse startPipeline(StartPipelineRequest startPipelineRequest)
                                     throws DisabledOperationException,
AccessDeniedException,
ConflictException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OsisException

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

Parameters:

startPipelineRequest -

Returns:

Result of the StartPipeline operation returned by the service.

See Also:

• AWS API Documentation

startPipeline

default StartPipelineResponse startPipeline(Consumer<StartPipelineRequest.Builder> startPipelineRequest)
                                     throws DisabledOperationException,
AccessDeniedException,
ConflictException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the StartPipeline operation returned by the service.

See Also:

• AWS API Documentation

stopPipeline

default StopPipelineResponse stopPipeline(StopPipelineRequest stopPipelineRequest)
                                   throws DisabledOperationException,
AccessDeniedException,
ConflictException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OsisException

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

Parameters:

stopPipelineRequest -

Returns:

Result of the StopPipeline operation returned by the service.

See Also:

• AWS API Documentation

stopPipeline

default StopPipelineResponse stopPipeline(Consumer<StopPipelineRequest.Builder> stopPipelineRequest)
                                   throws DisabledOperationException,
AccessDeniedException,
ConflictException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the StopPipeline operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws DisabledOperationException,
LimitExceededException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
OsisException

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws DisabledOperationException,
LimitExceededException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws DisabledOperationException,
ValidationException,
ResourceNotFoundException,
InternalException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
OsisException

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws DisabledOperationException,
ValidationException,
ResourceNotFoundException,
InternalException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updatePipeline

default UpdatePipelineResponse updatePipeline(UpdatePipelineRequest updatePipelineRequest)
                                       throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
OsisException

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

Parameters:

updatePipelineRequest -

Returns:

Result of the UpdatePipeline operation returned by the service.

See Also:

• AWS API Documentation

updatePipeline

default UpdatePipelineResponse updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)
                                       throws DisabledOperationException,
ValidationException,
InternalException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the UpdatePipeline operation returned by the service.

See Also:

• AWS API Documentation

validatePipeline

default ValidatePipelineResponse validatePipeline(ValidatePipelineRequest validatePipelineRequest)
                                           throws DisabledOperationException,
AccessDeniedException,
InternalException,
ValidationException,
AwsServiceException,
SdkClientException,
OsisException

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

Parameters:

validatePipelineRequest -

Returns:

Result of the ValidatePipeline operation returned by the service.

See Also:

• AWS API Documentation

validatePipeline

default ValidatePipelineResponse validatePipeline(Consumer<ValidatePipelineRequest.Builder> validatePipelineRequest)
                                           throws DisabledOperationException,
AccessDeniedException,
InternalException,
ValidationException,
AwsServiceException,
SdkClientException,
OsisException

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:

Result of the ValidatePipeline operation returned by the service.

See Also:

• AWS API Documentation

create

static OsisClient create()

Create a OsisClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static OsisClientBuilder builder()

Create a builder that can be used to configure and create a OsisClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

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