com.amazonaws.services.opensearchserverless.AWSOpenSearchServerless Maven / Gradle / Ivy
Show all versions of aws-java-sdk-opensearchserverless Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.opensearchserverless;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.opensearchserverless.model.*;
/**
* Interface for accessing OpenSearch Service Serverless.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.opensearchserverless.AbstractAWSOpenSearchServerless} instead.
*
*
*
* 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("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSOpenSearchServerless {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "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.
* @sample AWSOpenSearchServerless.BatchGetCollection
* @see AWS API Documentation
*/
BatchGetCollectionResult batchGetCollection(BatchGetCollectionRequest batchGetCollectionRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.BatchGetEffectiveLifecyclePolicy
* @see AWS API Documentation
*/
BatchGetEffectiveLifecyclePolicyResult batchGetEffectiveLifecyclePolicy(BatchGetEffectiveLifecyclePolicyRequest batchGetEffectiveLifecyclePolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.BatchGetLifecyclePolicy
* @see AWS API Documentation
*/
BatchGetLifecyclePolicyResult batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest batchGetLifecyclePolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.BatchGetVpcEndpoint
* @see AWS API Documentation
*/
BatchGetVpcEndpointResult batchGetVpcEndpoint(BatchGetVpcEndpointRequest batchGetVpcEndpointRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.CreateAccessPolicy
* @see AWS API Documentation
*/
CreateAccessPolicyResult createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.CreateCollection
* @see AWS API Documentation
*/
CreateCollectionResult createCollection(CreateCollectionRequest createCollectionRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.CreateLifecyclePolicy
* @see AWS API Documentation
*/
CreateLifecyclePolicyResult createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.CreateSecurityConfig
* @see AWS API Documentation
*/
CreateSecurityConfigResult createSecurityConfig(CreateSecurityConfigRequest createSecurityConfigRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.CreateSecurityPolicy
* @see AWS API Documentation
*/
CreateSecurityPolicyResult createSecurityPolicy(CreateSecurityPolicyRequest createSecurityPolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.CreateVpcEndpoint
* @see AWS API Documentation
*/
CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.DeleteAccessPolicy
* @see AWS API Documentation
*/
DeleteAccessPolicyResult deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.DeleteCollection
* @see AWS API Documentation
*/
DeleteCollectionResult deleteCollection(DeleteCollectionRequest deleteCollectionRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.DeleteLifecyclePolicy
* @see AWS API Documentation
*/
DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.DeleteSecurityConfig
* @see AWS API Documentation
*/
DeleteSecurityConfigResult deleteSecurityConfig(DeleteSecurityConfigRequest deleteSecurityConfigRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.DeleteSecurityPolicy
* @see AWS API Documentation
*/
DeleteSecurityPolicyResult deleteSecurityPolicy(DeleteSecurityPolicyRequest deleteSecurityPolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.DeleteVpcEndpoint
* @see AWS API Documentation
*/
DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.GetAccessPolicy
* @see AWS API Documentation
*/
GetAccessPolicyResult getAccessPolicy(GetAccessPolicyRequest getAccessPolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.GetAccountSettings
* @see AWS API Documentation
*/
GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.GetPoliciesStats
* @see AWS API Documentation
*/
GetPoliciesStatsResult getPoliciesStats(GetPoliciesStatsRequest getPoliciesStatsRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.GetSecurityConfig
* @see AWS API Documentation
*/
GetSecurityConfigResult getSecurityConfig(GetSecurityConfigRequest getSecurityConfigRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.GetSecurityPolicy
* @see AWS API Documentation
*/
GetSecurityPolicyResult getSecurityPolicy(GetSecurityPolicyRequest getSecurityPolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.ListAccessPolicies
* @see AWS API Documentation
*/
ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.ListCollections
* @see AWS API Documentation
*/
ListCollectionsResult listCollections(ListCollectionsRequest listCollectionsRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.ListLifecyclePolicies
* @see AWS API Documentation
*/
ListLifecyclePoliciesResult listLifecyclePolicies(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.ListSecurityConfigs
* @see AWS API Documentation
*/
ListSecurityConfigsResult listSecurityConfigs(ListSecurityConfigsRequest listSecurityConfigsRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.ListSecurityPolicies
* @see AWS API Documentation
*/
ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.ListVpcEndpoints
* @see AWS API Documentation
*/
ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.TagResource
* @see AWS API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.UntagResource
* @see AWS API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.UpdateAccessPolicy
* @see AWS API Documentation
*/
UpdateAccessPolicyResult updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.UpdateAccountSettings
* @see AWS API Documentation
*/
UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.UpdateCollection
* @see AWS API Documentation
*/
UpdateCollectionResult updateCollection(UpdateCollectionRequest updateCollectionRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.UpdateLifecyclePolicy
* @see AWS API Documentation
*/
UpdateLifecyclePolicyResult updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.UpdateSecurityConfig
* @see AWS API Documentation
*/
UpdateSecurityConfigResult updateSecurityConfig(UpdateSecurityConfigRequest updateSecurityConfigRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.UpdateSecurityPolicy
* @see AWS API Documentation
*/
UpdateSecurityPolicyResult updateSecurityPolicy(UpdateSecurityPolicyRequest updateSecurityPolicyRequest);
/**
*
* 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.
* @sample AWSOpenSearchServerless.UpdateVpcEndpoint
* @see AWS API Documentation
*/
UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}