com.amazonaws.services.osis

Class AbstractAmazonOSIS

java.lang.Object

com.amazonaws.services.osis.AbstractAmazonOSIS

All Implemented Interfaces:

AmazonOSIS

Direct Known Subclasses:

AbstractAmazonOSISAsync

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

Abstract implementation of AmazonOSIS. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
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 java.lang.Object

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

Method Detail

createPipeline

public CreatePipelineResult createPipeline(CreatePipelineRequest request)

Description copied from interface: AmazonOSIS

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

Specified by:

createPipeline in interface AmazonOSIS

Returns:

Result of the CreatePipeline operation returned by the service.

See Also:

AWS API Documentation

deletePipeline

public DeletePipelineResult deletePipeline(DeletePipelineRequest request)

Description copied from interface: AmazonOSIS

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

Specified by:

deletePipeline in interface AmazonOSIS

Returns:

Result of the DeletePipeline operation returned by the service.

See Also:

AWS API Documentation

getPipeline

public GetPipelineResult getPipeline(GetPipelineRequest request)

Description copied from interface: AmazonOSIS

Retrieves information about an OpenSearch Ingestion pipeline.

Specified by:

getPipeline in interface AmazonOSIS

Returns:

Result of the GetPipeline operation returned by the service.

See Also:

AWS API Documentation

getPipelineBlueprint

public GetPipelineBlueprintResult getPipelineBlueprint(GetPipelineBlueprintRequest request)

Description copied from interface: AmazonOSIS

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

Returns:

Result of the GetPipelineBlueprint operation returned by the service.

See Also:

AWS API Documentation

getPipelineChangeProgress

public GetPipelineChangeProgressResult getPipelineChangeProgress(GetPipelineChangeProgressRequest request)

Description copied from interface: AmazonOSIS

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

Returns:

Result of the GetPipelineChangeProgress operation returned by the service.

See Also:

AWS API Documentation

listPipelineBlueprints

public ListPipelineBlueprintsResult listPipelineBlueprints(ListPipelineBlueprintsRequest request)

Description copied from interface: AmazonOSIS

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

Returns:

Result of the ListPipelineBlueprints operation returned by the service.

See Also:

AWS API Documentation

listPipelines

public ListPipelinesResult listPipelines(ListPipelinesRequest request)

Description copied from interface: AmazonOSIS

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

Returns:

Result of the ListPipelines operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonOSIS

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

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

startPipeline

public StartPipelineResult startPipeline(StartPipelineRequest request)

Description copied from interface: AmazonOSIS

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

Specified by:

startPipeline in interface AmazonOSIS

Returns:

Result of the StartPipeline operation returned by the service.

See Also:

AWS API Documentation

stopPipeline

public StopPipelineResult stopPipeline(StopPipelineRequest request)

Description copied from interface: AmazonOSIS

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

Specified by:

stopPipeline in interface AmazonOSIS

Returns:

Result of the StopPipeline operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonOSIS

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

Specified by:

tagResource in interface AmazonOSIS

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonOSIS

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

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updatePipeline

public UpdatePipelineResult updatePipeline(UpdatePipelineRequest request)

Description copied from interface: AmazonOSIS

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

Specified by:

updatePipeline in interface AmazonOSIS

Returns:

Result of the UpdatePipeline operation returned by the service.

See Also:

AWS API Documentation

validatePipeline

public ValidatePipelineResult validatePipeline(ValidatePipelineRequest request)

Description copied from interface: AmazonOSIS

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

Returns:

Result of the ValidatePipeline operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonOSIS

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonOSIS

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonOSIS

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 a 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.