com.amazonaws.services.osis

Interface AmazonOSIS

All Known Subinterfaces:

AmazonOSISAsync

All Known Implementing Classes:

AbstractAmazonOSIS, AbstractAmazonOSISAsync, AmazonOSISAsyncClient, AmazonOSISClient

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

Interface for accessing Amazon OpenSearch Ingestion.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonOSIS 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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreatePipelineResult	createPipeline(CreatePipelineRequest createPipelineRequest) Creates an OpenSearch Ingestion pipeline.
DeletePipelineResult	deletePipeline(DeletePipelineRequest deletePipelineRequest) 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 getPipelineRequest) Retrieves information about an OpenSearch Ingestion pipeline.
GetPipelineBlueprintResult	getPipelineBlueprint(GetPipelineBlueprintRequest getPipelineBlueprintRequest) Retrieves information about a specific blueprint for OpenSearch Ingestion.
GetPipelineChangeProgressResult	getPipelineChangeProgress(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest) Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
ListPipelineBlueprintsResult	listPipelineBlueprints(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest) Retrieves a list of all available blueprints for Data Prepper.
ListPipelinesResult	listPipelines(ListPipelinesRequest listPipelinesRequest) Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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 startPipelineRequest) Starts an OpenSearch Ingestion pipeline.
StopPipelineResult	stopPipeline(StopPipelineRequest stopPipelineRequest) Stops an OpenSearch Ingestion pipeline.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Tags an OpenSearch Ingestion pipeline.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from an OpenSearch Ingestion pipeline.
UpdatePipelineResult	updatePipeline(UpdatePipelineRequest updatePipelineRequest) Updates an OpenSearch Ingestion pipeline.
ValidatePipelineResult	validatePipeline(ValidatePipelineRequest validatePipelineRequest) Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createPipeline

CreatePipelineResult createPipeline(CreatePipelineRequest createPipelineRequest)

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.

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

DeletePipelineResult deletePipeline(DeletePipelineRequest deletePipelineRequest)

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.

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

GetPipelineResult getPipeline(GetPipelineRequest getPipelineRequest)

Retrieves information about an OpenSearch Ingestion pipeline.

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

GetPipelineBlueprintResult 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:

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

GetPipelineChangeProgressResult 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:

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

ListPipelineBlueprintsResult 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:

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

ListPipelinesResult 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:

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

ListTagsForResourceResult 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:

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

StartPipelineResult startPipeline(StartPipelineRequest startPipelineRequest)

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.

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

StopPipelineResult stopPipeline(StopPipelineRequest stopPipelineRequest)

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.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

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

UntagResourceResult 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:

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

UpdatePipelineResult updatePipeline(UpdatePipelineRequest updatePipelineRequest)

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.

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

ValidatePipelineResult 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:

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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