com.amazonaws.services.osis

Class AmazonOSISClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.osis.AmazonOSISClient

All Implemented Interfaces:

AmazonOSIS

Direct Known Subclasses:

AmazonOSISAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonOSISClient
extends AmazonWebServiceClient
implements AmazonOSIS

Client for accessing Amazon OpenSearch Ingestion. All service calls made using this client are blocking, and will not return until the service call completes.

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 class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonOSISClientBuilder	builder()
CreatePipelineResult	createPipeline(CreatePipelineRequest request) Creates an OpenSearch Ingestion pipeline.
DeletePipelineResult	deletePipeline(DeletePipelineRequest request) Deletes an OpenSearch Ingestion pipeline.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetPipelineResult	getPipeline(GetPipelineRequest request) Retrieves information about an OpenSearch Ingestion pipeline.
GetPipelineBlueprintResult	getPipelineBlueprint(GetPipelineBlueprintRequest request) Retrieves information about a specific blueprint for OpenSearch Ingestion.
GetPipelineChangeProgressResult	getPipelineChangeProgress(GetPipelineChangeProgressRequest request) Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
ListPipelineBlueprintsResult	listPipelineBlueprints(ListPipelineBlueprintsRequest request) Retrieves a list of all available blueprints for Data Prepper.
ListPipelinesResult	listPipelines(ListPipelinesRequest request) Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all resource tags associated with an OpenSearch Ingestion pipeline.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartPipelineResult	startPipeline(StartPipelineRequest request) Starts an OpenSearch Ingestion pipeline.
StopPipelineResult	stopPipeline(StopPipelineRequest request) Stops an OpenSearch Ingestion pipeline.
TagResourceResult	tagResource(TagResourceRequest request) Tags an OpenSearch Ingestion pipeline.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes one or more tags from an OpenSearch Ingestion pipeline.
UpdatePipelineResult	updatePipeline(UpdatePipelineRequest request) Updates an OpenSearch Ingestion pipeline.
ValidatePipelineResult	validatePipeline(ValidatePipelineRequest request) Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AmazonOSISClientBuilder builder()

createPipeline

public CreatePipelineResult createPipeline(CreatePipelineRequest request)

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

Specified by:

createPipeline in interface AmazonOSIS

Parameters:

createPipelineRequest -

Returns:

Result of the CreatePipeline operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

deletePipeline

public DeletePipelineResult deletePipeline(DeletePipelineRequest request)

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

Specified by:

deletePipeline in interface AmazonOSIS

Parameters:

deletePipelineRequest -

Returns:

Result of the DeletePipeline operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

getPipeline

public GetPipelineResult getPipeline(GetPipelineRequest request)

Retrieves information about an OpenSearch Ingestion pipeline.

Specified by:

getPipeline in interface AmazonOSIS

Parameters:

getPipelineRequest -

Returns:

Result of the GetPipeline operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

getPipelineBlueprint

public GetPipelineBlueprintResult getPipelineBlueprint(GetPipelineBlueprintRequest request)

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.

Specified by:

getPipelineBlueprint in interface AmazonOSIS

Parameters:

getPipelineBlueprintRequest -

Returns:

Result of the GetPipelineBlueprint operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

getPipelineChangeProgress

public GetPipelineChangeProgressResult getPipelineChangeProgress(GetPipelineChangeProgressRequest request)

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.

Specified by:

getPipelineChangeProgress in interface AmazonOSIS

Parameters:

getPipelineChangeProgressRequest -

Returns:

Result of the GetPipelineChangeProgress operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

listPipelineBlueprints

public ListPipelineBlueprintsResult listPipelineBlueprints(ListPipelineBlueprintsRequest request)

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

Specified by:

listPipelineBlueprints in interface AmazonOSIS

Parameters:

listPipelineBlueprintsRequest -

Returns:

Result of the ListPipelineBlueprints operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

listPipelines

public ListPipelinesResult listPipelines(ListPipelinesRequest request)

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

Specified by:

listPipelines in interface AmazonOSIS

Parameters:

listPipelinesRequest -

Returns:

Result of the ListPipelines operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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

Specified by:

listTagsForResource in interface AmazonOSIS

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

startPipeline

public StartPipelineResult startPipeline(StartPipelineRequest request)

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

Specified by:

startPipeline in interface AmazonOSIS

Parameters:

startPipelineRequest -

Returns:

Result of the StartPipeline operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

stopPipeline

public StopPipelineResult stopPipeline(StopPipelineRequest request)

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

Specified by:

stopPipeline in interface AmazonOSIS

Parameters:

stopPipelineRequest -

Returns:

Result of the StopPipeline operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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

Specified by:

tagResource in interface AmazonOSIS

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

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

Specified by:

untagResource in interface AmazonOSIS

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

updatePipeline

public UpdatePipelineResult updatePipeline(UpdatePipelineRequest request)

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

Specified by:

updatePipeline in interface AmazonOSIS

Parameters:

updatePipelineRequest -

Returns:

Result of the UpdatePipeline operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

validatePipeline

public ValidatePipelineResult validatePipeline(ValidatePipelineRequest request)

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

Specified by:

validatePipeline in interface AmazonOSIS

Parameters:

validatePipelineRequest -

Returns:

Result of the ValidatePipeline operation returned by the service.

Throws:

DisabledOperationException - Exception is thrown when an operation has been disabled.

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonOSIS

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonOSIS

Overrides:

shutdown in class AmazonWebServiceClient