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 staticbuilder()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 StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static OsisClientBuilderbuilder()Create a builder that can be used to configure and create aOsisClient.static OsisClientcreate()Create aOsisClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreatePipelineResponsecreatePipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)Creates an OpenSearch Ingestion pipeline.default CreatePipelineResponsecreatePipeline(CreatePipelineRequest createPipelineRequest)Creates an OpenSearch Ingestion pipeline.default DeletePipelineResponsedeletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)Deletes an OpenSearch Ingestion pipeline.default DeletePipelineResponsedeletePipeline(DeletePipelineRequest deletePipelineRequest)Deletes an OpenSearch Ingestion pipeline.default GetPipelineResponsegetPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest)Retrieves information about an OpenSearch Ingestion pipeline.default GetPipelineResponsegetPipeline(GetPipelineRequest getPipelineRequest)Retrieves information about an OpenSearch Ingestion pipeline.default GetPipelineBlueprintResponsegetPipelineBlueprint(Consumer<GetPipelineBlueprintRequest.Builder> getPipelineBlueprintRequest)Retrieves information about a specific blueprint for OpenSearch Ingestion.default GetPipelineBlueprintResponsegetPipelineBlueprint(GetPipelineBlueprintRequest getPipelineBlueprintRequest)Retrieves information about a specific blueprint for OpenSearch Ingestion.default GetPipelineChangeProgressResponsegetPipelineChangeProgress(Consumer<GetPipelineChangeProgressRequest.Builder> getPipelineChangeProgressRequest)Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.default GetPipelineChangeProgressResponsegetPipelineChangeProgress(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest)Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.default ListPipelineBlueprintsResponselistPipelineBlueprints(Consumer<ListPipelineBlueprintsRequest.Builder> listPipelineBlueprintsRequest)Retrieves a list of all available blueprints for Data Prepper.default ListPipelineBlueprintsResponselistPipelineBlueprints(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest)Retrieves a list of all available blueprints for Data Prepper.default ListPipelinesResponselistPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.default ListPipelinesResponselistPipelines(ListPipelinesRequest listPipelinesRequest)Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.default ListPipelinesIterablelistPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.default ListPipelinesIterablelistPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists all resource tags associated with an OpenSearch Ingestion pipeline.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists all resource tags associated with an OpenSearch Ingestion pipeline.default OsisServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartPipelineResponsestartPipeline(Consumer<StartPipelineRequest.Builder> startPipelineRequest)Starts an OpenSearch Ingestion pipeline.default StartPipelineResponsestartPipeline(StartPipelineRequest startPipelineRequest)Starts an OpenSearch Ingestion pipeline.default StopPipelineResponsestopPipeline(Consumer<StopPipelineRequest.Builder> stopPipelineRequest)Stops an OpenSearch Ingestion pipeline.default StopPipelineResponsestopPipeline(StopPipelineRequest stopPipelineRequest)Stops an OpenSearch Ingestion pipeline.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Tags an OpenSearch Ingestion pipeline.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Tags an OpenSearch Ingestion pipeline.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes one or more tags from an OpenSearch Ingestion pipeline.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes one or more tags from an OpenSearch Ingestion pipeline.default UpdatePipelineResponseupdatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)Updates an OpenSearch Ingestion pipeline.default UpdatePipelineResponseupdatePipeline(UpdatePipelineRequest updatePipelineRequest)Updates an OpenSearch Ingestion pipeline.default ValidatePipelineResponsevalidatePipeline(Consumer<ValidatePipelineRequest.Builder> validatePipelineRequest)Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.default ValidatePipelineResponsevalidatePipeline(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 Detail
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createPipeline
default CreatePipelineResponse createPipeline(CreatePipelineRequest createPipelineRequest) throws LimitExceededException, ValidationException, InternalException, AccessDeniedException, ResourceAlreadyExistsException, 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPipeline
default CreatePipelineResponse createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest) throws LimitExceededException, ValidationException, InternalException, AccessDeniedException, ResourceAlreadyExistsException, 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.Builderavoiding the need to create one manually viaCreatePipelineRequest.builder()- Parameters:
createPipelineRequest- AConsumerthat will call methods onCreatePipelineRequest.Builderto create a request.- Returns:
- Result of the CreatePipeline operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePipeline
default DeletePipelineResponse deletePipeline(DeletePipelineRequest deletePipelineRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePipeline
default DeletePipelineResponse deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest) throws 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.Builderavoiding the need to create one manually viaDeletePipelineRequest.builder()- Parameters:
deletePipelineRequest- AConsumerthat will call methods onDeletePipelineRequest.Builderto create a request.- Returns:
- Result of the DeletePipeline operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPipeline
default GetPipelineResponse getPipeline(GetPipelineRequest getPipelineRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPipeline
default GetPipelineResponse getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest) throws 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.Builderavoiding the need to create one manually viaGetPipelineRequest.builder()- Parameters:
getPipelineRequest- AConsumerthat will call methods onGetPipelineRequest.Builderto create a request.- Returns:
- Result of the GetPipeline operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPipelineBlueprint
default GetPipelineBlueprintResponse getPipelineBlueprint(GetPipelineBlueprintRequest getPipelineBlueprintRequest) throws 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
CreatePipelinerequest. For more information, see Using blueprints to create a pipeline.- Parameters:
getPipelineBlueprintRequest-- Returns:
- Result of the GetPipelineBlueprint operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPipelineBlueprint
default GetPipelineBlueprintResponse getPipelineBlueprint(Consumer<GetPipelineBlueprintRequest.Builder> getPipelineBlueprintRequest) throws 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
CreatePipelinerequest. For more information, see Using blueprints to create a pipeline.
This is a convenience which creates an instance of the
GetPipelineBlueprintRequest.Builderavoiding the need to create one manually viaGetPipelineBlueprintRequest.builder()- Parameters:
getPipelineBlueprintRequest- AConsumerthat will call methods onGetPipelineBlueprintRequest.Builderto create a request.- Returns:
- Result of the GetPipelineBlueprint operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPipelineChangeProgress
default GetPipelineChangeProgressResponse getPipelineChangeProgress(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPipelineChangeProgress
default GetPipelineChangeProgressResponse getPipelineChangeProgress(Consumer<GetPipelineChangeProgressRequest.Builder> getPipelineChangeProgressRequest) throws 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.Builderavoiding the need to create one manually viaGetPipelineChangeProgressRequest.builder()- Parameters:
getPipelineChangeProgressRequest- AConsumerthat will call methods onGetPipelineChangeProgressRequest.Builderto create a request.- Returns:
- Result of the GetPipelineChangeProgress operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPipelineBlueprints
default ListPipelineBlueprintsResponse listPipelineBlueprints(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPipelineBlueprints
default ListPipelineBlueprintsResponse listPipelineBlueprints(Consumer<ListPipelineBlueprintsRequest.Builder> listPipelineBlueprintsRequest) throws 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.Builderavoiding the need to create one manually viaListPipelineBlueprintsRequest.builder()- Parameters:
listPipelineBlueprintsRequest- AConsumerthat will call methods onListPipelineBlueprintsRequest.Builderto create a request.- Returns:
- Result of the ListPipelineBlueprints operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPipelines
default ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPipelines
default ListPipelinesResponse listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) throws 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.Builderavoiding the need to create one manually viaListPipelinesRequest.builder()- Parameters:
listPipelinesRequest- AConsumerthat will call methods onListPipelinesRequest.Builderto create a request.- Returns:
- Result of the ListPipelines operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPipelinesPaginator
default ListPipelinesIterable listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest) throws 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 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
2) Using For loopsoftware.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPipelinesPaginator
default ListPipelinesIterable listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) throws 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 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
2) Using For loopsoftware.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListPipelinesRequest.builder()- Parameters:
listPipelinesRequest- AConsumerthat will call methods onListPipelinesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startPipeline
default StartPipelineResponse startPipeline(StartPipelineRequest startPipelineRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startPipeline
default StartPipelineResponse startPipeline(Consumer<StartPipelineRequest.Builder> startPipelineRequest) throws 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.Builderavoiding the need to create one manually viaStartPipelineRequest.builder()- Parameters:
startPipelineRequest- AConsumerthat will call methods onStartPipelineRequest.Builderto create a request.- Returns:
- Result of the StartPipeline operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopPipeline
default StopPipelineResponse stopPipeline(StopPipelineRequest stopPipelineRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopPipeline
default StopPipelineResponse stopPipeline(Consumer<StopPipelineRequest.Builder> stopPipelineRequest) throws 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.Builderavoiding the need to create one manually viaStopPipelineRequest.builder()- Parameters:
stopPipelineRequest- AConsumerthat will call methods onStopPipelineRequest.Builderto create a request.- Returns:
- Result of the StopPipeline operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePipeline
default UpdatePipelineResponse updatePipeline(UpdatePipelineRequest updatePipelineRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePipeline
default UpdatePipelineResponse updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest) throws 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.Builderavoiding the need to create one manually viaUpdatePipelineRequest.builder()- Parameters:
updatePipelineRequest- AConsumerthat will call methods onUpdatePipelineRequest.Builderto create a request.- Returns:
- Result of the UpdatePipeline operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
validatePipeline
default ValidatePipelineResponse validatePipeline(ValidatePipelineRequest validatePipelineRequest) throws 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.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
validatePipeline
default ValidatePipelineResponse validatePipeline(Consumer<ValidatePipelineRequest.Builder> validatePipelineRequest) throws 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.Builderavoiding the need to create one manually viaValidatePipelineRequest.builder()- Parameters:
validatePipelineRequest- AConsumerthat will call methods onValidatePipelineRequest.Builderto create a request.- Returns:
- Result of the ValidatePipeline operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.OsisException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static OsisClient create()
Create aOsisClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static OsisClientBuilder builder()
Create a builder that can be used to configure and create aOsisClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default OsisServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-