@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface OsisClient extends AwsClient
builder()
method.
Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see Getting data into your cluster using OpenSearch Ingestion.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static OsisClientBuilder |
builder()
Create a builder that can be used to configure and create a
OsisClient. |
static OsisClient |
create()
Create a
OsisClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreatePipelineResponse |
createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates an OpenSearch Ingestion pipeline.
|
default CreatePipelineResponse |
createPipeline(CreatePipelineRequest createPipelineRequest)
Creates an OpenSearch Ingestion pipeline.
|
default DeletePipelineResponse |
deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
Deletes an OpenSearch Ingestion pipeline.
|
default DeletePipelineResponse |
deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes an OpenSearch Ingestion pipeline.
|
default GetPipelineResponse |
getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest)
Retrieves information about an OpenSearch Ingestion pipeline.
|
default GetPipelineResponse |
getPipeline(GetPipelineRequest getPipelineRequest)
Retrieves information about an OpenSearch Ingestion pipeline.
|
default GetPipelineBlueprintResponse |
getPipelineBlueprint(Consumer<GetPipelineBlueprintRequest.Builder> getPipelineBlueprintRequest)
Retrieves information about a specific blueprint for OpenSearch Ingestion.
|
default GetPipelineBlueprintResponse |
getPipelineBlueprint(GetPipelineBlueprintRequest getPipelineBlueprintRequest)
Retrieves information about a specific blueprint for OpenSearch Ingestion.
|
default GetPipelineChangeProgressResponse |
getPipelineChangeProgress(Consumer<GetPipelineChangeProgressRequest.Builder> getPipelineChangeProgressRequest)
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
|
default GetPipelineChangeProgressResponse |
getPipelineChangeProgress(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest)
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
|
default ListPipelineBlueprintsResponse |
listPipelineBlueprints(Consumer<ListPipelineBlueprintsRequest.Builder> listPipelineBlueprintsRequest)
Retrieves a list of all available blueprints for Data Prepper.
|
default ListPipelineBlueprintsResponse |
listPipelineBlueprints(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest)
Retrieves a list of all available blueprints for Data Prepper.
|
default ListPipelinesResponse |
listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
|
default ListPipelinesResponse |
listPipelines(ListPipelinesRequest listPipelinesRequest)
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
|
default ListPipelinesIterable |
listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
|
default ListPipelinesIterable |
listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all resource tags associated with an OpenSearch Ingestion pipeline.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all resource tags associated with an OpenSearch Ingestion pipeline.
|
default OsisServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartPipelineResponse |
startPipeline(Consumer<StartPipelineRequest.Builder> startPipelineRequest)
Starts an OpenSearch Ingestion pipeline.
|
default StartPipelineResponse |
startPipeline(StartPipelineRequest startPipelineRequest)
Starts an OpenSearch Ingestion pipeline.
|
default StopPipelineResponse |
stopPipeline(Consumer<StopPipelineRequest.Builder> stopPipelineRequest)
Stops an OpenSearch Ingestion pipeline.
|
default StopPipelineResponse |
stopPipeline(StopPipelineRequest stopPipelineRequest)
Stops an OpenSearch Ingestion pipeline.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags an OpenSearch Ingestion pipeline.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Tags an OpenSearch Ingestion pipeline.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from an OpenSearch Ingestion pipeline.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from an OpenSearch Ingestion pipeline.
|
default UpdatePipelineResponse |
updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)
Updates an OpenSearch Ingestion pipeline.
|
default UpdatePipelineResponse |
updatePipeline(UpdatePipelineRequest updatePipelineRequest)
Updates an OpenSearch Ingestion pipeline.
|
default ValidatePipelineResponse |
validatePipeline(Consumer<ValidatePipelineRequest.Builder> validatePipelineRequest)
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
|
default ValidatePipelineResponse |
validatePipeline(ValidatePipelineRequest validatePipelineRequest)
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
createPipelineRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via CreatePipelineRequest.builder()
createPipelineRequest - A Consumer that will call methods on
CreatePipelineRequest.Builder to create a request.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.AwsServiceExceptiondefault 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.
deletePipelineRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DeletePipelineRequest.builder()
deletePipelineRequest - A Consumer that will call methods on
DeletePipelineRequest.Builder to create a request.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.AwsServiceExceptiondefault GetPipelineResponse getPipeline(GetPipelineRequest getPipelineRequest) throws ValidationException, InternalException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, OsisException
Retrieves information about an OpenSearch Ingestion pipeline.
getPipelineRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via GetPipelineRequest.builder()
getPipelineRequest - A Consumer that will call methods on
GetPipelineRequest.Builder to create a request.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.AwsServiceExceptiondefault 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 CreatePipeline request. For more information, see Using blueprints to create a pipeline.
getPipelineBlueprintRequest - 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.AwsServiceExceptiondefault 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 CreatePipeline request. For more information, see Using blueprints to create a pipeline.
This is a convenience which creates an instance of the GetPipelineBlueprintRequest.Builder avoiding the
need to create one manually via GetPipelineBlueprintRequest.builder()
getPipelineBlueprintRequest - A Consumer that will call methods on
GetPipelineBlueprintRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
getPipelineChangeProgressRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via GetPipelineChangeProgressRequest.builder()
getPipelineChangeProgressRequest - A Consumer that will call methods on
GetPipelineChangeProgressRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
listPipelineBlueprintsRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListPipelineBlueprintsRequest.builder()
listPipelineBlueprintsRequest - A Consumer that will call methods on
ListPipelineBlueprintsRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
listPipelinesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest - A Consumer that will call methods on
ListPipelinesRequest.Builder to create a request.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.AwsServiceExceptiondefault 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
software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
for (software.amazon.awssdk.services.osis.model.ListPipelinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) operation.
listPipelinesRequest - 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.AwsServiceExceptiondefault 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
software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
for (software.amazon.awssdk.services.osis.model.ListPipelinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.osis.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) operation.
This is a convenience which creates an instance of the ListPipelinesRequest.Builder avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest - A Consumer that will call methods on
ListPipelinesRequest.Builder to create a request.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.AwsServiceExceptiondefault 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.
listTagsForResourceRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault 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.
startPipelineRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via StartPipelineRequest.builder()
startPipelineRequest - A Consumer that will call methods on
StartPipelineRequest.Builder to create a request.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.AwsServiceExceptiondefault 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.
stopPipelineRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via StopPipelineRequest.builder()
stopPipelineRequest - A Consumer that will call methods on
StopPipelineRequest.Builder to create a request.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.AwsServiceExceptiondefault 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.
tagResourceRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault 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.
untagResourceRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault 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.
updatePipelineRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via UpdatePipelineRequest.builder()
updatePipelineRequest - A Consumer that will call methods on
UpdatePipelineRequest.Builder to create a request.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.AwsServiceExceptiondefault 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.
validatePipelineRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via ValidatePipelineRequest.builder()
validatePipelineRequest - A Consumer that will call methods on
ValidatePipelineRequest.Builder to create a request.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.AwsServiceExceptionstatic OsisClient create()
OsisClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static OsisClientBuilder builder()
OsisClient.static ServiceMetadata serviceMetadata()
default OsisServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.