software.amazon.awssdk.services.opensearchserverless.OpenSearchServerlessClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.opensearchserverless;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.opensearchserverless.model.BatchGetCollectionRequest;
import software.amazon.awssdk.services.opensearchserverless.model.BatchGetCollectionResponse;
import software.amazon.awssdk.services.opensearchserverless.model.BatchGetEffectiveLifecyclePolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.BatchGetEffectiveLifecyclePolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.BatchGetLifecyclePolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.BatchGetLifecyclePolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.BatchGetVpcEndpointRequest;
import software.amazon.awssdk.services.opensearchserverless.model.BatchGetVpcEndpointResponse;
import software.amazon.awssdk.services.opensearchserverless.model.ConflictException;
import software.amazon.awssdk.services.opensearchserverless.model.CreateAccessPolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.CreateAccessPolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.CreateCollectionRequest;
import software.amazon.awssdk.services.opensearchserverless.model.CreateCollectionResponse;
import software.amazon.awssdk.services.opensearchserverless.model.CreateLifecyclePolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.CreateLifecyclePolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.CreateSecurityConfigRequest;
import software.amazon.awssdk.services.opensearchserverless.model.CreateSecurityConfigResponse;
import software.amazon.awssdk.services.opensearchserverless.model.CreateSecurityPolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.CreateSecurityPolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.CreateVpcEndpointRequest;
import software.amazon.awssdk.services.opensearchserverless.model.CreateVpcEndpointResponse;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteAccessPolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteAccessPolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteCollectionRequest;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteCollectionResponse;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteLifecyclePolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteLifecyclePolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteSecurityConfigRequest;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteSecurityConfigResponse;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteSecurityPolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteSecurityPolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteVpcEndpointRequest;
import software.amazon.awssdk.services.opensearchserverless.model.DeleteVpcEndpointResponse;
import software.amazon.awssdk.services.opensearchserverless.model.GetAccessPolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.GetAccessPolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.GetAccountSettingsRequest;
import software.amazon.awssdk.services.opensearchserverless.model.GetAccountSettingsResponse;
import software.amazon.awssdk.services.opensearchserverless.model.GetPoliciesStatsRequest;
import software.amazon.awssdk.services.opensearchserverless.model.GetPoliciesStatsResponse;
import software.amazon.awssdk.services.opensearchserverless.model.GetSecurityConfigRequest;
import software.amazon.awssdk.services.opensearchserverless.model.GetSecurityConfigResponse;
import software.amazon.awssdk.services.opensearchserverless.model.GetSecurityPolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.GetSecurityPolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.InternalServerException;
import software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest;
import software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse;
import software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest;
import software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse;
import software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest;
import software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesResponse;
import software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest;
import software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse;
import software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest;
import software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse;
import software.amazon.awssdk.services.opensearchserverless.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.opensearchserverless.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest;
import software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse;
import software.amazon.awssdk.services.opensearchserverless.model.OcuLimitExceededException;
import software.amazon.awssdk.services.opensearchserverless.model.OpenSearchServerlessException;
import software.amazon.awssdk.services.opensearchserverless.model.ResourceNotFoundException;
import software.amazon.awssdk.services.opensearchserverless.model.ServiceQuotaExceededException;
import software.amazon.awssdk.services.opensearchserverless.model.TagResourceRequest;
import software.amazon.awssdk.services.opensearchserverless.model.TagResourceResponse;
import software.amazon.awssdk.services.opensearchserverless.model.UntagResourceRequest;
import software.amazon.awssdk.services.opensearchserverless.model.UntagResourceResponse;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateAccessPolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateAccessPolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateAccountSettingsRequest;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateAccountSettingsResponse;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateCollectionRequest;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateCollectionResponse;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateLifecyclePolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateLifecyclePolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateSecurityConfigRequest;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateSecurityConfigResponse;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateSecurityPolicyRequest;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateSecurityPolicyResponse;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateVpcEndpointRequest;
import software.amazon.awssdk.services.opensearchserverless.model.UpdateVpcEndpointResponse;
import software.amazon.awssdk.services.opensearchserverless.model.ValidationException;
import software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable;
import software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable;
import software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable;
import software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable;
import software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable;
import software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable;
/**
* Service client for accessing OpenSearch Service Serverless. This can be created using the static {@link #builder()}
* method.
*
*
* Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and
* security policies.
*
*
* OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service.
* OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch
* clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying
* infrastructure and data management.
*
*
* To learn more about OpenSearch Serverless, see What is Amazon
* OpenSearch Serverless?
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface OpenSearchServerlessClient extends AwsClient {
String SERVICE_NAME = "aoss";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "aoss";
/**
*
* Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards
* endpoint. For more information, see Creating and
* managing Amazon OpenSearch Serverless collections.
*
*
* @param batchGetCollectionRequest
* @return Result of the BatchGetCollection operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.BatchGetCollection
* @see AWS API Documentation
*/
default BatchGetCollectionResponse batchGetCollection(BatchGetCollectionRequest batchGetCollectionRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards
* endpoint. For more information, see Creating and
* managing Amazon OpenSearch Serverless collections.
*
*
*
* This is a convenience which creates an instance of the {@link BatchGetCollectionRequest.Builder} avoiding the
* need to create one manually via {@link BatchGetCollectionRequest#builder()}
*
*
* @param batchGetCollectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.BatchGetCollectionRequest.Builder} to
* create a request.
* @return Result of the BatchGetCollection operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.BatchGetCollection
* @see AWS API Documentation
*/
default BatchGetCollectionResponse batchGetCollection(Consumer batchGetCollectionRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return batchGetCollection(BatchGetCollectionRequest.builder().applyMutation(batchGetCollectionRequest).build());
}
/**
*
* Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information,
* see Viewing data lifecycle policies.
*
*
* @param batchGetEffectiveLifecyclePolicyRequest
* @return Result of the BatchGetEffectiveLifecyclePolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.BatchGetEffectiveLifecyclePolicy
* @see AWS API Documentation
*/
default BatchGetEffectiveLifecyclePolicyResponse batchGetEffectiveLifecyclePolicy(
BatchGetEffectiveLifecyclePolicyRequest batchGetEffectiveLifecyclePolicyRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information,
* see Viewing data lifecycle policies.
*
*
*
* This is a convenience which creates an instance of the {@link BatchGetEffectiveLifecyclePolicyRequest.Builder}
* avoiding the need to create one manually via {@link BatchGetEffectiveLifecyclePolicyRequest#builder()}
*
*
* @param batchGetEffectiveLifecyclePolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.BatchGetEffectiveLifecyclePolicyRequest.Builder}
* to create a request.
* @return Result of the BatchGetEffectiveLifecyclePolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.BatchGetEffectiveLifecyclePolicy
* @see AWS API Documentation
*/
default BatchGetEffectiveLifecyclePolicyResponse batchGetEffectiveLifecyclePolicy(
Consumer batchGetEffectiveLifecyclePolicyRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return batchGetEffectiveLifecyclePolicy(BatchGetEffectiveLifecyclePolicyRequest.builder()
.applyMutation(batchGetEffectiveLifecyclePolicyRequest).build());
}
/**
*
* Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
*
*
* @param batchGetLifecyclePolicyRequest
* @return Result of the BatchGetLifecyclePolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.BatchGetLifecyclePolicy
* @see AWS API Documentation
*/
default BatchGetLifecyclePolicyResponse batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest batchGetLifecyclePolicyRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
*
*
*
* This is a convenience which creates an instance of the {@link BatchGetLifecyclePolicyRequest.Builder} avoiding
* the need to create one manually via {@link BatchGetLifecyclePolicyRequest#builder()}
*
*
* @param batchGetLifecyclePolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.BatchGetLifecyclePolicyRequest.Builder}
* to create a request.
* @return Result of the BatchGetLifecyclePolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.BatchGetLifecyclePolicy
* @see AWS API Documentation
*/
default BatchGetLifecyclePolicyResponse batchGetLifecyclePolicy(
Consumer batchGetLifecyclePolicyRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest.builder().applyMutation(batchGetLifecyclePolicyRequest)
.build());
}
/**
*
* Returns attributes for one or more VPC endpoints associated with the current account. For more information, see
* Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
* @param batchGetVpcEndpointRequest
* @return Result of the BatchGetVpcEndpoint operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.BatchGetVpcEndpoint
* @see AWS API Documentation
*/
default BatchGetVpcEndpointResponse batchGetVpcEndpoint(BatchGetVpcEndpointRequest batchGetVpcEndpointRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns attributes for one or more VPC endpoints associated with the current account. For more information, see
* Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
*
* This is a convenience which creates an instance of the {@link BatchGetVpcEndpointRequest.Builder} avoiding the
* need to create one manually via {@link BatchGetVpcEndpointRequest#builder()}
*
*
* @param batchGetVpcEndpointRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.BatchGetVpcEndpointRequest.Builder} to
* create a request.
* @return Result of the BatchGetVpcEndpoint operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.BatchGetVpcEndpoint
* @see AWS API Documentation
*/
default BatchGetVpcEndpointResponse batchGetVpcEndpoint(
Consumer batchGetVpcEndpointRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return batchGetVpcEndpoint(BatchGetVpcEndpointRequest.builder().applyMutation(batchGetVpcEndpointRequest).build());
}
/**
*
* Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the
* resources within them, and allow a user to access that data irrespective of the access mechanism or network
* source. For more information, see Data
* access control for Amazon OpenSearch Serverless.
*
*
* @param createAccessPolicyRequest
* @return Result of the CreateAccessPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateAccessPolicy
* @see AWS API Documentation
*/
default CreateAccessPolicyResponse createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)
throws InternalServerException, ConflictException, ValidationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the
* resources within them, and allow a user to access that data irrespective of the access mechanism or network
* source. For more information, see Data
* access control for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link CreateAccessPolicyRequest.Builder} avoiding the
* need to create one manually via {@link CreateAccessPolicyRequest#builder()}
*
*
* @param createAccessPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.CreateAccessPolicyRequest.Builder} to
* create a request.
* @return Result of the CreateAccessPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateAccessPolicy
* @see AWS API Documentation
*/
default CreateAccessPolicyResponse createAccessPolicy(Consumer createAccessPolicyRequest)
throws InternalServerException, ConflictException, ValidationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
return createAccessPolicy(CreateAccessPolicyRequest.builder().applyMutation(createAccessPolicyRequest).build());
}
/**
*
* Creates a new OpenSearch Serverless collection. For more information, see Creating and
* managing Amazon OpenSearch Serverless collections.
*
*
* @param createCollectionRequest
* @return Result of the CreateCollection operation returned by the service.
* @throws OcuLimitExceededException
* Thrown when the collection you're attempting to create results in a number of search or indexing OCUs
* that exceeds the account limit.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateCollection
* @see AWS API Documentation
*/
default CreateCollectionResponse createCollection(CreateCollectionRequest createCollectionRequest)
throws OcuLimitExceededException, InternalServerException, ConflictException, ValidationException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new OpenSearch Serverless collection. For more information, see Creating and
* managing Amazon OpenSearch Serverless collections.
*
*
*
* This is a convenience which creates an instance of the {@link CreateCollectionRequest.Builder} avoiding the need
* to create one manually via {@link CreateCollectionRequest#builder()}
*
*
* @param createCollectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.CreateCollectionRequest.Builder} to
* create a request.
* @return Result of the CreateCollection operation returned by the service.
* @throws OcuLimitExceededException
* Thrown when the collection you're attempting to create results in a number of search or indexing OCUs
* that exceeds the account limit.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateCollection
* @see AWS API Documentation
*/
default CreateCollectionResponse createCollection(Consumer createCollectionRequest)
throws OcuLimitExceededException, InternalServerException, ConflictException, ValidationException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return createCollection(CreateCollectionRequest.builder().applyMutation(createCollectionRequest).build());
}
/**
*
* Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of
* days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.
*
*
* @param createLifecyclePolicyRequest
* @return Result of the CreateLifecyclePolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateLifecyclePolicy
* @see AWS API Documentation
*/
default CreateLifecyclePolicyResponse createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)
throws InternalServerException, ConflictException, ValidationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of
* days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.
*
*
*
* This is a convenience which creates an instance of the {@link CreateLifecyclePolicyRequest.Builder} avoiding the
* need to create one manually via {@link CreateLifecyclePolicyRequest#builder()}
*
*
* @param createLifecyclePolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.CreateLifecyclePolicyRequest.Builder} to
* create a request.
* @return Result of the CreateLifecyclePolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateLifecyclePolicy
* @see AWS API Documentation
*/
default CreateLifecyclePolicyResponse createLifecyclePolicy(
Consumer createLifecyclePolicyRequest) throws InternalServerException,
ConflictException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return createLifecyclePolicy(CreateLifecyclePolicyRequest.builder().applyMutation(createLifecyclePolicyRequest).build());
}
/**
*
* Specifies a security configuration for OpenSearch Serverless. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
* @param createSecurityConfigRequest
* @return Result of the CreateSecurityConfig operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateSecurityConfig
* @see AWS API Documentation
*/
default CreateSecurityConfigResponse createSecurityConfig(CreateSecurityConfigRequest createSecurityConfigRequest)
throws InternalServerException, ConflictException, ValidationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Specifies a security configuration for OpenSearch Serverless. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link CreateSecurityConfigRequest.Builder} avoiding the
* need to create one manually via {@link CreateSecurityConfigRequest#builder()}
*
*
* @param createSecurityConfigRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.CreateSecurityConfigRequest.Builder} to
* create a request.
* @return Result of the CreateSecurityConfig operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateSecurityConfig
* @see AWS API Documentation
*/
default CreateSecurityConfigResponse createSecurityConfig(
Consumer createSecurityConfigRequest) throws InternalServerException,
ConflictException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return createSecurityConfig(CreateSecurityConfigRequest.builder().applyMutation(createSecurityConfigRequest).build());
}
/**
*
* Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide
* access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints.
* They also allow you to secure a collection with a KMS encryption key. For more information, see Network
* access for Amazon OpenSearch Serverless and Encryption
* at rest for Amazon OpenSearch Serverless.
*
*
* @param createSecurityPolicyRequest
* @return Result of the CreateSecurityPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateSecurityPolicy
* @see AWS API Documentation
*/
default CreateSecurityPolicyResponse createSecurityPolicy(CreateSecurityPolicyRequest createSecurityPolicyRequest)
throws InternalServerException, ConflictException, ValidationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide
* access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints.
* They also allow you to secure a collection with a KMS encryption key. For more information, see Network
* access for Amazon OpenSearch Serverless and Encryption
* at rest for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link CreateSecurityPolicyRequest.Builder} avoiding the
* need to create one manually via {@link CreateSecurityPolicyRequest#builder()}
*
*
* @param createSecurityPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.CreateSecurityPolicyRequest.Builder} to
* create a request.
* @return Result of the CreateSecurityPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateSecurityPolicy
* @see AWS API Documentation
*/
default CreateSecurityPolicyResponse createSecurityPolicy(
Consumer createSecurityPolicyRequest) throws InternalServerException,
ConflictException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return createSecurityPolicy(CreateSecurityPolicyRequest.builder().applyMutation(createSecurityPolicyRequest).build());
}
/**
*
* Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
* @param createVpcEndpointRequest
* @return Result of the CreateVpcEndpoint operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateVpcEndpoint
* @see AWS API Documentation
*/
default CreateVpcEndpointResponse createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)
throws InternalServerException, ConflictException, ValidationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
*
* This is a convenience which creates an instance of the {@link CreateVpcEndpointRequest.Builder} avoiding the need
* to create one manually via {@link CreateVpcEndpointRequest#builder()}
*
*
* @param createVpcEndpointRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.CreateVpcEndpointRequest.Builder} to
* create a request.
* @return Result of the CreateVpcEndpoint operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.CreateVpcEndpoint
* @see AWS API Documentation
*/
default CreateVpcEndpointResponse createVpcEndpoint(Consumer createVpcEndpointRequest)
throws InternalServerException, ConflictException, ValidationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
return createVpcEndpoint(CreateVpcEndpointRequest.builder().applyMutation(createVpcEndpointRequest).build());
}
/**
*
* Deletes an OpenSearch Serverless access policy. For more information, see Data
* access control for Amazon OpenSearch Serverless.
*
*
* @param deleteAccessPolicyRequest
* @return Result of the DeleteAccessPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteAccessPolicy
* @see AWS API Documentation
*/
default DeleteAccessPolicyResponse deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an OpenSearch Serverless access policy. For more information, see Data
* access control for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAccessPolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteAccessPolicyRequest#builder()}
*
*
* @param deleteAccessPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.DeleteAccessPolicyRequest.Builder} to
* create a request.
* @return Result of the DeleteAccessPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteAccessPolicy
* @see AWS API Documentation
*/
default DeleteAccessPolicyResponse deleteAccessPolicy(Consumer deleteAccessPolicyRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
return deleteAccessPolicy(DeleteAccessPolicyRequest.builder().applyMutation(deleteAccessPolicyRequest).build());
}
/**
*
* Deletes an OpenSearch Serverless collection. For more information, see Creating and
* managing Amazon OpenSearch Serverless collections.
*
*
* @param deleteCollectionRequest
* @return Result of the DeleteCollection operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteCollection
* @see AWS API Documentation
*/
default DeleteCollectionResponse deleteCollection(DeleteCollectionRequest deleteCollectionRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an OpenSearch Serverless collection. For more information, see Creating and
* managing Amazon OpenSearch Serverless collections.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteCollectionRequest.Builder} avoiding the need
* to create one manually via {@link DeleteCollectionRequest#builder()}
*
*
* @param deleteCollectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.DeleteCollectionRequest.Builder} to
* create a request.
* @return Result of the DeleteCollection operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteCollection
* @see AWS API Documentation
*/
default DeleteCollectionResponse deleteCollection(Consumer deleteCollectionRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
return deleteCollection(DeleteCollectionRequest.builder().applyMutation(deleteCollectionRequest).build());
}
/**
*
* Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.
*
*
* @param deleteLifecyclePolicyRequest
* @return Result of the DeleteLifecyclePolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteLifecyclePolicy
* @see AWS API Documentation
*/
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteLifecyclePolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteLifecyclePolicyRequest#builder()}
*
*
* @param deleteLifecyclePolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.DeleteLifecyclePolicyRequest.Builder} to
* create a request.
* @return Result of the DeleteLifecyclePolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteLifecyclePolicy
* @see AWS API Documentation
*/
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(
Consumer deleteLifecyclePolicyRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return deleteLifecyclePolicy(DeleteLifecyclePolicyRequest.builder().applyMutation(deleteLifecyclePolicyRequest).build());
}
/**
*
* Deletes a security configuration for OpenSearch Serverless. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
* @param deleteSecurityConfigRequest
* @return Result of the DeleteSecurityConfig operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteSecurityConfig
* @see AWS API Documentation
*/
default DeleteSecurityConfigResponse deleteSecurityConfig(DeleteSecurityConfigRequest deleteSecurityConfigRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a security configuration for OpenSearch Serverless. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteSecurityConfigRequest.Builder} avoiding the
* need to create one manually via {@link DeleteSecurityConfigRequest#builder()}
*
*
* @param deleteSecurityConfigRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.DeleteSecurityConfigRequest.Builder} to
* create a request.
* @return Result of the DeleteSecurityConfig operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteSecurityConfig
* @see AWS API Documentation
*/
default DeleteSecurityConfigResponse deleteSecurityConfig(
Consumer deleteSecurityConfigRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return deleteSecurityConfig(DeleteSecurityConfigRequest.builder().applyMutation(deleteSecurityConfigRequest).build());
}
/**
*
* Deletes an OpenSearch Serverless security policy.
*
*
* @param deleteSecurityPolicyRequest
* @return Result of the DeleteSecurityPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteSecurityPolicy
* @see AWS API Documentation
*/
default DeleteSecurityPolicyResponse deleteSecurityPolicy(DeleteSecurityPolicyRequest deleteSecurityPolicyRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an OpenSearch Serverless security policy.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteSecurityPolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteSecurityPolicyRequest#builder()}
*
*
* @param deleteSecurityPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.DeleteSecurityPolicyRequest.Builder} to
* create a request.
* @return Result of the DeleteSecurityPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteSecurityPolicy
* @see AWS API Documentation
*/
default DeleteSecurityPolicyResponse deleteSecurityPolicy(
Consumer deleteSecurityPolicyRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return deleteSecurityPolicy(DeleteSecurityPolicyRequest.builder().applyMutation(deleteSecurityPolicyRequest).build());
}
/**
*
* Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
* @param deleteVpcEndpointRequest
* @return Result of the DeleteVpcEndpoint operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteVpcEndpoint
* @see AWS API Documentation
*/
default DeleteVpcEndpointResponse deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteVpcEndpointRequest.Builder} avoiding the need
* to create one manually via {@link DeleteVpcEndpointRequest#builder()}
*
*
* @param deleteVpcEndpointRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.DeleteVpcEndpointRequest.Builder} to
* create a request.
* @return Result of the DeleteVpcEndpoint operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.DeleteVpcEndpoint
* @see AWS API Documentation
*/
default DeleteVpcEndpointResponse deleteVpcEndpoint(Consumer deleteVpcEndpointRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
return deleteVpcEndpoint(DeleteVpcEndpointRequest.builder().applyMutation(deleteVpcEndpointRequest).build());
}
/**
*
* Returns an OpenSearch Serverless access policy. For more information, see Data
* access control for Amazon OpenSearch Serverless.
*
*
* @param getAccessPolicyRequest
* @return Result of the GetAccessPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.GetAccessPolicy
* @see AWS API Documentation
*/
default GetAccessPolicyResponse getAccessPolicy(GetAccessPolicyRequest getAccessPolicyRequest)
throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException,
SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns an OpenSearch Serverless access policy. For more information, see Data
* access control for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link GetAccessPolicyRequest.Builder} avoiding the need
* to create one manually via {@link GetAccessPolicyRequest#builder()}
*
*
* @param getAccessPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.GetAccessPolicyRequest.Builder} to
* create a request.
* @return Result of the GetAccessPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.GetAccessPolicy
* @see AWS API Documentation
*/
default GetAccessPolicyResponse getAccessPolicy(Consumer getAccessPolicyRequest)
throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException,
SdkClientException, OpenSearchServerlessException {
return getAccessPolicy(GetAccessPolicyRequest.builder().applyMutation(getAccessPolicyRequest).build());
}
/**
*
* Returns account-level settings related to OpenSearch Serverless.
*
*
* @param getAccountSettingsRequest
* @return Result of the GetAccountSettings operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.GetAccountSettings
* @see AWS API Documentation
*/
default GetAccountSettingsResponse getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns account-level settings related to OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link GetAccountSettingsRequest.Builder} avoiding the
* need to create one manually via {@link GetAccountSettingsRequest#builder()}
*
*
* @param getAccountSettingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.GetAccountSettingsRequest.Builder} to
* create a request.
* @return Result of the GetAccountSettings operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.GetAccountSettings
* @see AWS API Documentation
*/
default GetAccountSettingsResponse getAccountSettings(Consumer getAccountSettingsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return getAccountSettings(GetAccountSettingsRequest.builder().applyMutation(getAccountSettingsRequest).build());
}
/**
*
* Returns statistical information about your OpenSearch Serverless access policies, security configurations, and
* security policies.
*
*
* @param getPoliciesStatsRequest
* @return Result of the GetPoliciesStats operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.GetPoliciesStats
* @see AWS API Documentation
*/
default GetPoliciesStatsResponse getPoliciesStats(GetPoliciesStatsRequest getPoliciesStatsRequest)
throws InternalServerException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns statistical information about your OpenSearch Serverless access policies, security configurations, and
* security policies.
*
*
*
* This is a convenience which creates an instance of the {@link GetPoliciesStatsRequest.Builder} avoiding the need
* to create one manually via {@link GetPoliciesStatsRequest#builder()}
*
*
* @param getPoliciesStatsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.GetPoliciesStatsRequest.Builder} to
* create a request.
* @return Result of the GetPoliciesStats operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.GetPoliciesStats
* @see AWS API Documentation
*/
default GetPoliciesStatsResponse getPoliciesStats(Consumer getPoliciesStatsRequest)
throws InternalServerException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return getPoliciesStats(GetPoliciesStatsRequest.builder().applyMutation(getPoliciesStatsRequest).build());
}
/**
*
* Returns information about an OpenSearch Serverless security configuration. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
* @param getSecurityConfigRequest
* @return Result of the GetSecurityConfig operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.GetSecurityConfig
* @see AWS API Documentation
*/
default GetSecurityConfigResponse getSecurityConfig(GetSecurityConfigRequest getSecurityConfigRequest)
throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException,
SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about an OpenSearch Serverless security configuration. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link GetSecurityConfigRequest.Builder} avoiding the need
* to create one manually via {@link GetSecurityConfigRequest#builder()}
*
*
* @param getSecurityConfigRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.GetSecurityConfigRequest.Builder} to
* create a request.
* @return Result of the GetSecurityConfig operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.GetSecurityConfig
* @see AWS API Documentation
*/
default GetSecurityConfigResponse getSecurityConfig(Consumer getSecurityConfigRequest)
throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException,
SdkClientException, OpenSearchServerlessException {
return getSecurityConfig(GetSecurityConfigRequest.builder().applyMutation(getSecurityConfigRequest).build());
}
/**
*
* Returns information about a configured OpenSearch Serverless security policy. For more information, see Network
* access for Amazon OpenSearch Serverless and Encryption
* at rest for Amazon OpenSearch Serverless.
*
*
* @param getSecurityPolicyRequest
* @return Result of the GetSecurityPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.GetSecurityPolicy
* @see AWS API Documentation
*/
default GetSecurityPolicyResponse getSecurityPolicy(GetSecurityPolicyRequest getSecurityPolicyRequest)
throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException,
SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about a configured OpenSearch Serverless security policy. For more information, see Network
* access for Amazon OpenSearch Serverless and Encryption
* at rest for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link GetSecurityPolicyRequest.Builder} avoiding the need
* to create one manually via {@link GetSecurityPolicyRequest#builder()}
*
*
* @param getSecurityPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.GetSecurityPolicyRequest.Builder} to
* create a request.
* @return Result of the GetSecurityPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.GetSecurityPolicy
* @see AWS API Documentation
*/
default GetSecurityPolicyResponse getSecurityPolicy(Consumer getSecurityPolicyRequest)
throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException,
SdkClientException, OpenSearchServerlessException {
return getSecurityPolicy(GetSecurityPolicyRequest.builder().applyMutation(getSecurityPolicyRequest).build());
}
/**
*
* Returns information about a list of OpenSearch Serverless access policies.
*
*
* @param listAccessPoliciesRequest
* @return Result of the ListAccessPolicies operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListAccessPolicies
* @see AWS API Documentation
*/
default ListAccessPoliciesResponse listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about a list of OpenSearch Serverless access policies.
*
*
*
* This is a convenience which creates an instance of the {@link ListAccessPoliciesRequest.Builder} avoiding the
* need to create one manually via {@link ListAccessPoliciesRequest#builder()}
*
*
* @param listAccessPoliciesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest.Builder} to
* create a request.
* @return Result of the ListAccessPolicies operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListAccessPolicies
* @see AWS API Documentation
*/
default ListAccessPoliciesResponse listAccessPolicies(Consumer listAccessPoliciesRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return listAccessPolicies(ListAccessPoliciesRequest.builder().applyMutation(listAccessPoliciesRequest).build());
}
/**
*
* Returns information about a list of OpenSearch Serverless access policies.
*
*
*
* This is a variant of
* {@link #listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client
* .listAccessPoliciesPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(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
* {@link #listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest)}
* operation.
*
*
* @param listAccessPoliciesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListAccessPolicies
* @see AWS API Documentation
*/
default ListAccessPoliciesIterable listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return new ListAccessPoliciesIterable(this, listAccessPoliciesRequest);
}
/**
*
* Returns information about a list of OpenSearch Serverless access policies.
*
*
*
* This is a variant of
* {@link #listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client
* .listAccessPoliciesPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(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
* {@link #listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListAccessPoliciesRequest.Builder} avoiding the
* need to create one manually via {@link ListAccessPoliciesRequest#builder()}
*
*
* @param listAccessPoliciesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListAccessPolicies
* @see AWS API Documentation
*/
default ListAccessPoliciesIterable listAccessPoliciesPaginator(
Consumer listAccessPoliciesRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return listAccessPoliciesPaginator(ListAccessPoliciesRequest.builder().applyMutation(listAccessPoliciesRequest).build());
}
/**
*
* Lists all OpenSearch Serverless collections. For more information, see Creating and
* managing Amazon OpenSearch Serverless collections.
*
*
*
* Make sure to include an empty request body {} if you don't include any collection filters in the request.
*
*
*
* @param listCollectionsRequest
* @return Result of the ListCollections operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListCollections
* @see AWS API Documentation
*/
default ListCollectionsResponse listCollections(ListCollectionsRequest listCollectionsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Lists all OpenSearch Serverless collections. For more information, see Creating and
* managing Amazon OpenSearch Serverless collections.
*
*
*
* Make sure to include an empty request body {} if you don't include any collection filters in the request.
*
*
*
* This is a convenience which creates an instance of the {@link ListCollectionsRequest.Builder} avoiding the need
* to create one manually via {@link ListCollectionsRequest#builder()}
*
*
* @param listCollectionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest.Builder} to
* create a request.
* @return Result of the ListCollections operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListCollections
* @see AWS API Documentation
*/
default ListCollectionsResponse listCollections(Consumer listCollectionsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return listCollections(ListCollectionsRequest.builder().applyMutation(listCollectionsRequest).build());
}
/**
*
* Lists all OpenSearch Serverless collections. For more information, see Creating and
* managing Amazon OpenSearch Serverless collections.
*
*
*
* Make sure to include an empty request body {} if you don't include any collection filters in the request.
*
*
*
* This is a variant of
* {@link #listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client
* .listCollectionsPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(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
* {@link #listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest)}
* operation.
*
*
* @param listCollectionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListCollections
* @see AWS API Documentation
*/
default ListCollectionsIterable listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return new ListCollectionsIterable(this, listCollectionsRequest);
}
/**
*
* Lists all OpenSearch Serverless collections. For more information, see Creating and
* managing Amazon OpenSearch Serverless collections.
*
*
*
* Make sure to include an empty request body {} if you don't include any collection filters in the request.
*
*
*
* This is a variant of
* {@link #listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client
* .listCollectionsPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(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
* {@link #listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListCollectionsRequest.Builder} avoiding the need
* to create one manually via {@link ListCollectionsRequest#builder()}
*
*
* @param listCollectionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListCollections
* @see AWS API Documentation
*/
default ListCollectionsIterable listCollectionsPaginator(Consumer listCollectionsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return listCollectionsPaginator(ListCollectionsRequest.builder().applyMutation(listCollectionsRequest).build());
}
/**
*
* Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
*
*
* @param listLifecyclePoliciesRequest
* @return Result of the ListLifecyclePolicies operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListLifecyclePolicies
* @see AWS API Documentation
*/
default ListLifecyclePoliciesResponse listLifecyclePolicies(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
*
*
*
* This is a convenience which creates an instance of the {@link ListLifecyclePoliciesRequest.Builder} avoiding the
* need to create one manually via {@link ListLifecyclePoliciesRequest#builder()}
*
*
* @param listLifecyclePoliciesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest.Builder} to
* create a request.
* @return Result of the ListLifecyclePolicies operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListLifecyclePolicies
* @see AWS API Documentation
*/
default ListLifecyclePoliciesResponse listLifecyclePolicies(
Consumer listLifecyclePoliciesRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return listLifecyclePolicies(ListLifecyclePoliciesRequest.builder().applyMutation(listLifecyclePoliciesRequest).build());
}
/**
*
* Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
*
*
*
* This is a variant of
* {@link #listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client
* .listLifecyclePoliciesPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(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
* {@link #listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest)}
* operation.
*
*
* @param listLifecyclePoliciesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListLifecyclePolicies
* @see AWS API Documentation
*/
default ListLifecyclePoliciesIterable listLifecyclePoliciesPaginator(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return new ListLifecyclePoliciesIterable(this, listLifecyclePoliciesRequest);
}
/**
*
* Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
*
*
*
* This is a variant of
* {@link #listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client
* .listLifecyclePoliciesPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(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
* {@link #listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListLifecyclePoliciesRequest.Builder} avoiding the
* need to create one manually via {@link ListLifecyclePoliciesRequest#builder()}
*
*
* @param listLifecyclePoliciesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListLifecyclePolicies
* @see AWS API Documentation
*/
default ListLifecyclePoliciesIterable listLifecyclePoliciesPaginator(
Consumer listLifecyclePoliciesRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return listLifecyclePoliciesPaginator(ListLifecyclePoliciesRequest.builder().applyMutation(listLifecyclePoliciesRequest)
.build());
}
/**
*
* Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
* @param listSecurityConfigsRequest
* @return Result of the ListSecurityConfigs operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListSecurityConfigs
* @see AWS API Documentation
*/
default ListSecurityConfigsResponse listSecurityConfigs(ListSecurityConfigsRequest listSecurityConfigsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link ListSecurityConfigsRequest.Builder} avoiding the
* need to create one manually via {@link ListSecurityConfigsRequest#builder()}
*
*
* @param listSecurityConfigsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest.Builder} to
* create a request.
* @return Result of the ListSecurityConfigs operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListSecurityConfigs
* @see AWS API Documentation
*/
default ListSecurityConfigsResponse listSecurityConfigs(
Consumer listSecurityConfigsRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return listSecurityConfigs(ListSecurityConfigsRequest.builder().applyMutation(listSecurityConfigsRequest).build());
}
/**
*
* Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
*
* This is a variant of
* {@link #listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client.listSecurityConfigsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client
* .listSecurityConfigsPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client.listSecurityConfigsPaginator(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
* {@link #listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest)}
* operation.
*
*
* @param listSecurityConfigsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListSecurityConfigs
* @see AWS API Documentation
*/
default ListSecurityConfigsIterable listSecurityConfigsPaginator(ListSecurityConfigsRequest listSecurityConfigsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return new ListSecurityConfigsIterable(this, listSecurityConfigsRequest);
}
/**
*
* Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
*
* This is a variant of
* {@link #listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client.listSecurityConfigsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client
* .listSecurityConfigsPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client.listSecurityConfigsPaginator(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
* {@link #listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListSecurityConfigsRequest.Builder} avoiding the
* need to create one manually via {@link ListSecurityConfigsRequest#builder()}
*
*
* @param listSecurityConfigsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListSecurityConfigs
* @see AWS API Documentation
*/
default ListSecurityConfigsIterable listSecurityConfigsPaginator(
Consumer listSecurityConfigsRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return listSecurityConfigsPaginator(ListSecurityConfigsRequest.builder().applyMutation(listSecurityConfigsRequest)
.build());
}
/**
*
* Returns information about configured OpenSearch Serverless security policies.
*
*
* @param listSecurityPoliciesRequest
* @return Result of the ListSecurityPolicies operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListSecurityPolicies
* @see AWS API Documentation
*/
default ListSecurityPoliciesResponse listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about configured OpenSearch Serverless security policies.
*
*
*
* This is a convenience which creates an instance of the {@link ListSecurityPoliciesRequest.Builder} avoiding the
* need to create one manually via {@link ListSecurityPoliciesRequest#builder()}
*
*
* @param listSecurityPoliciesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest.Builder} to
* create a request.
* @return Result of the ListSecurityPolicies operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListSecurityPolicies
* @see AWS API Documentation
*/
default ListSecurityPoliciesResponse listSecurityPolicies(
Consumer listSecurityPoliciesRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return listSecurityPolicies(ListSecurityPoliciesRequest.builder().applyMutation(listSecurityPoliciesRequest).build());
}
/**
*
* Returns information about configured OpenSearch Serverless security policies.
*
*
*
* This is a variant of
* {@link #listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client
* .listSecurityPoliciesPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(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
* {@link #listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest)}
* operation.
*
*
* @param listSecurityPoliciesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListSecurityPolicies
* @see AWS API Documentation
*/
default ListSecurityPoliciesIterable listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return new ListSecurityPoliciesIterable(this, listSecurityPoliciesRequest);
}
/**
*
* Returns information about configured OpenSearch Serverless security policies.
*
*
*
* This is a variant of
* {@link #listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client
* .listSecurityPoliciesPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(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
* {@link #listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListSecurityPoliciesRequest.Builder} avoiding the
* need to create one manually via {@link ListSecurityPoliciesRequest#builder()}
*
*
* @param listSecurityPoliciesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListSecurityPolicies
* @see AWS API Documentation
*/
default ListSecurityPoliciesIterable listSecurityPoliciesPaginator(
Consumer listSecurityPoliciesRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return listSecurityPoliciesPaginator(ListSecurityPoliciesRequest.builder().applyMutation(listSecurityPoliciesRequest)
.build());
}
/**
*
* Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon
* OpenSearch Serverless collections.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException,
SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon
* OpenSearch Serverless collections.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListTagsForResourceRequest.Builder} to
* create a request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws InternalServerException,
ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more
* information, see Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
* @param listVpcEndpointsRequest
* @return Result of the ListVpcEndpoints operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListVpcEndpoints
* @see AWS API Documentation
*/
default ListVpcEndpointsResponse listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more
* information, see Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
*
* This is a convenience which creates an instance of the {@link ListVpcEndpointsRequest.Builder} avoiding the need
* to create one manually via {@link ListVpcEndpointsRequest#builder()}
*
*
* @param listVpcEndpointsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest.Builder} to
* create a request.
* @return Result of the ListVpcEndpoints operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListVpcEndpoints
* @see AWS API Documentation
*/
default ListVpcEndpointsResponse listVpcEndpoints(Consumer listVpcEndpointsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return listVpcEndpoints(ListVpcEndpointsRequest.builder().applyMutation(listVpcEndpointsRequest).build());
}
/**
*
* Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more
* information, see Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
*
* This is a variant of
* {@link #listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client.listVpcEndpointsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client
* .listVpcEndpointsPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client.listVpcEndpointsPaginator(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
* {@link #listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest)}
* operation.
*
*
* @param listVpcEndpointsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListVpcEndpoints
* @see AWS API Documentation
*/
default ListVpcEndpointsIterable listVpcEndpointsPaginator(ListVpcEndpointsRequest listVpcEndpointsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return new ListVpcEndpointsIterable(this, listVpcEndpointsRequest);
}
/**
*
* Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more
* information, see Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
*
* This is a variant of
* {@link #listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client.listVpcEndpointsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client
* .listVpcEndpointsPaginator(request);
* for (software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client.listVpcEndpointsPaginator(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
* {@link #listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListVpcEndpointsRequest.Builder} avoiding the need
* to create one manually via {@link ListVpcEndpointsRequest#builder()}
*
*
* @param listVpcEndpointsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.ListVpcEndpoints
* @see AWS API Documentation
*/
default ListVpcEndpointsIterable listVpcEndpointsPaginator(Consumer listVpcEndpointsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return listVpcEndpointsPaginator(ListVpcEndpointsRequest.builder().applyMutation(listVpcEndpointsRequest).build());
}
/**
*
* Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon
* OpenSearch Serverless collections.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.TagResource
* @see AWS API Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, ValidationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon
* OpenSearch Serverless collections.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.TagResourceRequest.Builder} to create a
* request.
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.TagResource
* @see AWS API Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon
* OpenSearch Serverless collections.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UntagResource
* @see AWS API Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon
* OpenSearch Serverless collections.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.UntagResourceRequest.Builder} to create
* a request.
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UntagResource
* @see AWS API Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates an OpenSearch Serverless access policy. For more information, see Data
* access control for Amazon OpenSearch Serverless.
*
*
* @param updateAccessPolicyRequest
* @return Result of the UpdateAccessPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateAccessPolicy
* @see AWS API Documentation
*/
default UpdateAccessPolicyResponse updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an OpenSearch Serverless access policy. For more information, see Data
* access control for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateAccessPolicyRequest.Builder} avoiding the
* need to create one manually via {@link UpdateAccessPolicyRequest#builder()}
*
*
* @param updateAccessPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.UpdateAccessPolicyRequest.Builder} to
* create a request.
* @return Result of the UpdateAccessPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateAccessPolicy
* @see AWS API Documentation
*/
default UpdateAccessPolicyResponse updateAccessPolicy(Consumer updateAccessPolicyRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
return updateAccessPolicy(UpdateAccessPolicyRequest.builder().applyMutation(updateAccessPolicyRequest).build());
}
/**
*
* Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see
* Managing
* capacity limits for Amazon OpenSearch Serverless.
*
*
* @param updateAccountSettingsRequest
* @return Result of the UpdateAccountSettings operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateAccountSettings
* @see AWS API Documentation
*/
default UpdateAccountSettingsResponse updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
throws InternalServerException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see
* Managing
* capacity limits for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateAccountSettingsRequest.Builder} avoiding the
* need to create one manually via {@link UpdateAccountSettingsRequest#builder()}
*
*
* @param updateAccountSettingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.UpdateAccountSettingsRequest.Builder} to
* create a request.
* @return Result of the UpdateAccountSettings operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateAccountSettings
* @see AWS API Documentation
*/
default UpdateAccountSettingsResponse updateAccountSettings(
Consumer updateAccountSettingsRequest) throws InternalServerException,
ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
return updateAccountSettings(UpdateAccountSettingsRequest.builder().applyMutation(updateAccountSettingsRequest).build());
}
/**
*
* Updates an OpenSearch Serverless collection.
*
*
* @param updateCollectionRequest
* @return Result of the UpdateCollection operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateCollection
* @see AWS API Documentation
*/
default UpdateCollectionResponse updateCollection(UpdateCollectionRequest updateCollectionRequest)
throws InternalServerException, ConflictException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an OpenSearch Serverless collection.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateCollectionRequest.Builder} avoiding the need
* to create one manually via {@link UpdateCollectionRequest#builder()}
*
*
* @param updateCollectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.UpdateCollectionRequest.Builder} to
* create a request.
* @return Result of the UpdateCollection operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateCollection
* @see AWS API Documentation
*/
default UpdateCollectionResponse updateCollection(Consumer updateCollectionRequest)
throws InternalServerException, ConflictException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return updateCollection(UpdateCollectionRequest.builder().applyMutation(updateCollectionRequest).build());
}
/**
*
* Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.
*
*
* @param updateLifecyclePolicyRequest
* @return Result of the UpdateLifecyclePolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateLifecyclePolicy
* @see AWS API Documentation
*/
default UpdateLifecyclePolicyResponse updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateLifecyclePolicyRequest.Builder} avoiding the
* need to create one manually via {@link UpdateLifecyclePolicyRequest#builder()}
*
*
* @param updateLifecyclePolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.UpdateLifecyclePolicyRequest.Builder} to
* create a request.
* @return Result of the UpdateLifecyclePolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateLifecyclePolicy
* @see AWS API Documentation
*/
default UpdateLifecyclePolicyResponse updateLifecyclePolicy(
Consumer updateLifecyclePolicyRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, ValidationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
return updateLifecyclePolicy(UpdateLifecyclePolicyRequest.builder().applyMutation(updateLifecyclePolicyRequest).build());
}
/**
*
* Updates a security configuration for OpenSearch Serverless. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
* @param updateSecurityConfigRequest
* @return Result of the UpdateSecurityConfig operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateSecurityConfig
* @see AWS API Documentation
*/
default UpdateSecurityConfigResponse updateSecurityConfig(UpdateSecurityConfigRequest updateSecurityConfigRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a security configuration for OpenSearch Serverless. For more information, see SAML
* authentication for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateSecurityConfigRequest.Builder} avoiding the
* need to create one manually via {@link UpdateSecurityConfigRequest#builder()}
*
*
* @param updateSecurityConfigRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.UpdateSecurityConfigRequest.Builder} to
* create a request.
* @return Result of the UpdateSecurityConfig operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateSecurityConfig
* @see AWS API Documentation
*/
default UpdateSecurityConfigResponse updateSecurityConfig(
Consumer updateSecurityConfigRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return updateSecurityConfig(UpdateSecurityConfigRequest.builder().applyMutation(updateSecurityConfigRequest).build());
}
/**
*
* Updates an OpenSearch Serverless security policy. For more information, see Network
* access for Amazon OpenSearch Serverless and Encryption
* at rest for Amazon OpenSearch Serverless.
*
*
* @param updateSecurityPolicyRequest
* @return Result of the UpdateSecurityPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateSecurityPolicy
* @see AWS API Documentation
*/
default UpdateSecurityPolicyResponse updateSecurityPolicy(UpdateSecurityPolicyRequest updateSecurityPolicyRequest)
throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an OpenSearch Serverless security policy. For more information, see Network
* access for Amazon OpenSearch Serverless and Encryption
* at rest for Amazon OpenSearch Serverless.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateSecurityPolicyRequest.Builder} avoiding the
* need to create one manually via {@link UpdateSecurityPolicyRequest#builder()}
*
*
* @param updateSecurityPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.UpdateSecurityPolicyRequest.Builder} to
* create a request.
* @return Result of the UpdateSecurityPolicy operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ResourceNotFoundException
* Thrown when accessing or deleting a resource that does not exist.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws ServiceQuotaExceededException
* Thrown when you attempt to create more resources than the service allows based on service quotas.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateSecurityPolicy
* @see AWS API Documentation
*/
default UpdateSecurityPolicyResponse updateSecurityPolicy(
Consumer updateSecurityPolicyRequest) throws InternalServerException,
ResourceNotFoundException, ConflictException, ValidationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, OpenSearchServerlessException {
return updateSecurityPolicy(UpdateSecurityPolicyRequest.builder().applyMutation(updateSecurityPolicyRequest).build());
}
/**
*
* Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
* @param updateVpcEndpointRequest
* @return Result of the UpdateVpcEndpoint operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateVpcEndpoint
* @see AWS API Documentation
*/
default UpdateVpcEndpointResponse updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)
throws InternalServerException, ConflictException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon
* OpenSearch Serverless using an interface endpoint.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateVpcEndpointRequest.Builder} avoiding the need
* to create one manually via {@link UpdateVpcEndpointRequest#builder()}
*
*
* @param updateVpcEndpointRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.opensearchserverless.model.UpdateVpcEndpointRequest.Builder} to
* create a request.
* @return Result of the UpdateVpcEndpoint operation returned by the service.
* @throws InternalServerException
* Thrown when an error internal to the service occurs while processing a request.
* @throws ConflictException
* When creating a resource, thrown when a resource with the same name already exists or is being created.
* When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
* @throws ValidationException
* Thrown when the HTTP request contains invalid input or is missing required input.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws OpenSearchServerlessException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample OpenSearchServerlessClient.UpdateVpcEndpoint
* @see AWS API Documentation
*/
default UpdateVpcEndpointResponse updateVpcEndpoint(Consumer updateVpcEndpointRequest)
throws InternalServerException, ConflictException, ValidationException, AwsServiceException, SdkClientException,
OpenSearchServerlessException {
return updateVpcEndpoint(UpdateVpcEndpointRequest.builder().applyMutation(updateVpcEndpointRequest).build());
}
/**
* Create a {@link OpenSearchServerlessClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static OpenSearchServerlessClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link OpenSearchServerlessClient}.
*/
static OpenSearchServerlessClientBuilder builder() {
return new DefaultOpenSearchServerlessClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default OpenSearchServerlessServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
}