AWSOpenSearchServerlessClient (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.opensearchserverless

Class AWSOpenSearchServerlessClient

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.opensearchserverless.AWSOpenSearchServerlessClient

All Implemented Interfaces:

AWSOpenSearchServerless

Direct Known Subclasses:

AWSOpenSearchServerlessAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSOpenSearchServerlessClient
extends AmazonWebServiceClient
implements AWSOpenSearchServerless 
```
Client for accessing OpenSearch Service Serverless. All service calls made using this client are blocking, and will not return until the service call completes.

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?

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.opensearchserverless.AWSOpenSearchServerless
  ENDPOINT_PREFIX

Method Summary

All Methods
Modifier and Type	Method and Description
`BatchGetCollectionResult`	`batchGetCollection (BatchGetCollectionRequest request)` Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint.
`BatchGetEffectiveLifecyclePolicyResult`	`batchGetEffectiveLifecyclePolicy (BatchGetEffectiveLifecyclePolicyRequest request)` Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes.
`BatchGetLifecyclePolicyResult`	`batchGetLifecyclePolicy (BatchGetLifecyclePolicyRequest request)` Returns one or more configured OpenSearch Serverless lifecycle policies.
`BatchGetVpcEndpointResult`	`batchGetVpcEndpoint (BatchGetVpcEndpointRequest request)` Returns attributes for one or more VPC endpoints associated with the current account.
`static AWSOpenSearchServerlessClientBuilder`	`builder ()`
`CreateAccessPolicyResult`	`createAccessPolicy (CreateAccessPolicyRequest request)` Creates a data access policy for OpenSearch Serverless.
`CreateCollectionResult`	`createCollection (CreateCollectionRequest request)` Creates a new OpenSearch Serverless collection.
`CreateLifecyclePolicyResult`	`createLifecyclePolicy (CreateLifecyclePolicyRequest request)` Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.
`CreateSecurityConfigResult`	`createSecurityConfig (CreateSecurityConfigRequest request)` Specifies a security configuration for OpenSearch Serverless.
`CreateSecurityPolicyResult`	`createSecurityPolicy (CreateSecurityPolicyRequest request)` Creates a security policy to be used by one or more OpenSearch Serverless collections.
`CreateVpcEndpointResult`	`createVpcEndpoint (CreateVpcEndpointRequest request)` Creates an OpenSearch Serverless-managed interface VPC endpoint.
`DeleteAccessPolicyResult`	`deleteAccessPolicy (DeleteAccessPolicyRequest request)` Deletes an OpenSearch Serverless access policy.
`DeleteCollectionResult`	`deleteCollection (DeleteCollectionRequest request)` Deletes an OpenSearch Serverless collection.
`DeleteLifecyclePolicyResult`	`deleteLifecyclePolicy (DeleteLifecyclePolicyRequest request)` Deletes an OpenSearch Serverless lifecycle policy.
`DeleteSecurityConfigResult`	`deleteSecurityConfig (DeleteSecurityConfigRequest request)` Deletes a security configuration for OpenSearch Serverless.
`DeleteSecurityPolicyResult`	`deleteSecurityPolicy (DeleteSecurityPolicyRequest request)` Deletes an OpenSearch Serverless security policy.
`DeleteVpcEndpointResult`	`deleteVpcEndpoint (DeleteVpcEndpointRequest request)` Deletes an OpenSearch Serverless-managed interface endpoint.
`GetAccessPolicyResult`	`getAccessPolicy (GetAccessPolicyRequest request)` Returns an OpenSearch Serverless access policy.
`GetAccountSettingsResult`	`getAccountSettings (GetAccountSettingsRequest request)` Returns account-level settings related to OpenSearch Serverless.
`ResponseMetadata`	`getCachedResponseMetadata (AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetPoliciesStatsResult`	`getPoliciesStats (GetPoliciesStatsRequest request)` Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
`GetSecurityConfigResult`	`getSecurityConfig (GetSecurityConfigRequest request)` Returns information about an OpenSearch Serverless security configuration.
`GetSecurityPolicyResult`	`getSecurityPolicy (GetSecurityPolicyRequest request)` Returns information about a configured OpenSearch Serverless security policy.
`ListAccessPoliciesResult`	`listAccessPolicies (ListAccessPoliciesRequest request)` Returns information about a list of OpenSearch Serverless access policies.
`ListCollectionsResult`	`listCollections (ListCollectionsRequest request)` Lists all OpenSearch Serverless collections.
`ListLifecyclePoliciesResult`	`listLifecyclePolicies (ListLifecyclePoliciesRequest request)` Returns a list of OpenSearch Serverless lifecycle policies.
`ListSecurityConfigsResult`	`listSecurityConfigs (ListSecurityConfigsRequest request)` Returns information about configured OpenSearch Serverless security configurations.
`ListSecurityPoliciesResult`	`listSecurityPolicies (ListSecurityPoliciesRequest request)` Returns information about configured OpenSearch Serverless security policies.
`ListTagsForResourceResult`	`listTagsForResource (ListTagsForResourceRequest request)` Returns the tags for an OpenSearch Serverless resource.
`ListVpcEndpointsResult`	`listVpcEndpoints (ListVpcEndpointsRequest request)` Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource (TagResourceRequest request)` Associates tags with an OpenSearch Serverless resource.
`UntagResourceResult`	`untagResource (UntagResourceRequest request)` Removes a tag or set of tags from an OpenSearch Serverless resource.
`UpdateAccessPolicyResult`	`updateAccessPolicy (UpdateAccessPolicyRequest request)` Updates an OpenSearch Serverless access policy.
`UpdateAccountSettingsResult`	`updateAccountSettings (UpdateAccountSettingsRequest request)` Update the OpenSearch Serverless settings for the current Amazon Web Services account.
`UpdateCollectionResult`	`updateCollection (UpdateCollectionRequest request)` Updates an OpenSearch Serverless collection.
`UpdateLifecyclePolicyResult`	`updateLifecyclePolicy (UpdateLifecyclePolicyRequest request)` Updates an OpenSearch Serverless access policy.
`UpdateSecurityConfigResult`	`updateSecurityConfig (UpdateSecurityConfigRequest request)` Updates a security configuration for OpenSearch Serverless.
`UpdateSecurityPolicyResult`	`updateSecurityPolicy (UpdateSecurityPolicyRequest request)` Updates an OpenSearch Serverless security policy.
`UpdateVpcEndpointResult`	`updateVpcEndpoint (UpdateVpcEndpointRequest request)` Updates an OpenSearch Serverless-managed interface endpoint.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSOpenSearchServerlessClientBuilder builder()
```
  - batchGetCollection
```
public BatchGetCollectionResult batchGetCollection(BatchGetCollectionRequest request)
```
    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.
    
    Specified by:
    
    batchGetCollection in interface AWSOpenSearchServerless
    
    Parameters:
    
    batchGetCollectionRequest -
    
    Returns:
    
    Result of the BatchGetCollection operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - batchGetEffectiveLifecyclePolicy
```
public BatchGetEffectiveLifecyclePolicyResult batchGetEffectiveLifecyclePolicy(BatchGetEffectiveLifecyclePolicyRequest request)
```
    Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.
    
    Specified by:
    
    batchGetEffectiveLifecyclePolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    batchGetEffectiveLifecyclePolicyRequest -
    
    Returns:
    
    Result of the BatchGetEffectiveLifecyclePolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - batchGetLifecyclePolicy
```
public BatchGetLifecyclePolicyResult batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest request)
```
    Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
    
    Specified by:
    
    batchGetLifecyclePolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    batchGetLifecyclePolicyRequest -
    
    Returns:
    
    Result of the BatchGetLifecyclePolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - batchGetVpcEndpoint
```
public BatchGetVpcEndpointResult batchGetVpcEndpoint(BatchGetVpcEndpointRequest request)
```
    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.
    
    Specified by:
    
    batchGetVpcEndpoint in interface AWSOpenSearchServerless
    
    Parameters:
    
    batchGetVpcEndpointRequest -
    
    Returns:
    
    Result of the BatchGetVpcEndpoint operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - createAccessPolicy
```
public CreateAccessPolicyResult createAccessPolicy(CreateAccessPolicyRequest request)
```
    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.
    
    Specified by:
    
    createAccessPolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    createAccessPolicyRequest -
    
    Returns:
    
    Result of the CreateAccessPolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.
    
    See Also:
    
    AWS API Documentation
  - createCollection
```
public CreateCollectionResult createCollection(CreateCollectionRequest request)
```
    Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
    
    Specified by:
    
    createCollection in interface AWSOpenSearchServerless
    
    Parameters:
    
    createCollectionRequest -
    
    Returns:
    
    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.
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.
    
    See Also:
    
    AWS API Documentation
  - createLifecyclePolicy
```
public CreateLifecyclePolicyResult createLifecyclePolicy(CreateLifecyclePolicyRequest request)
```
    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.
    
    Specified by:
    
    createLifecyclePolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    createLifecyclePolicyRequest -
    
    Returns:
    
    Result of the CreateLifecyclePolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.
    
    See Also:
    
    AWS API Documentation
  - createSecurityConfig
```
public CreateSecurityConfigResult createSecurityConfig(CreateSecurityConfigRequest request)
```
    Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
    
    Specified by:
    
    createSecurityConfig in interface AWSOpenSearchServerless
    
    Parameters:
    
    createSecurityConfigRequest -
    
    Returns:
    
    Result of the CreateSecurityConfig operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.
    
    See Also:
    
    AWS API Documentation
  - createSecurityPolicy
```
public CreateSecurityPolicyResult createSecurityPolicy(CreateSecurityPolicyRequest request)
```
    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.
    
    Specified by:
    
    createSecurityPolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    createSecurityPolicyRequest -
    
    Returns:
    
    Result of the CreateSecurityPolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.
    
    See Also:
    
    AWS API Documentation
  - createVpcEndpoint
```
public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)
```
    Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
    
    Specified by:
    
    createVpcEndpoint in interface AWSOpenSearchServerless
    
    Parameters:
    
    createVpcEndpointRequest -
    
    Returns:
    
    Result of the CreateVpcEndpoint operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.
    
    See Also:
    
    AWS API Documentation
  - deleteAccessPolicy
```
public DeleteAccessPolicyResult deleteAccessPolicy(DeleteAccessPolicyRequest request)
```
    Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
    
    Specified by:
    
    deleteAccessPolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    deleteAccessPolicyRequest -
    
    Returns:
    
    Result of the DeleteAccessPolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - deleteCollection
```
public DeleteCollectionResult deleteCollection(DeleteCollectionRequest request)
```
    Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
    
    Specified by:
    
    deleteCollection in interface AWSOpenSearchServerless
    
    Parameters:
    
    deleteCollectionRequest -
    
    Returns:
    
    Result of the DeleteCollection operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - deleteLifecyclePolicy
```
public DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request)
```
    Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.
    
    Specified by:
    
    deleteLifecyclePolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    deleteLifecyclePolicyRequest -
    
    Returns:
    
    Result of the DeleteLifecyclePolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - deleteSecurityConfig
```
public DeleteSecurityConfigResult deleteSecurityConfig(DeleteSecurityConfigRequest request)
```
    Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
    
    Specified by:
    
    deleteSecurityConfig in interface AWSOpenSearchServerless
    
    Parameters:
    
    deleteSecurityConfigRequest -
    
    Returns:
    
    Result of the DeleteSecurityConfig operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - deleteSecurityPolicy
```
public DeleteSecurityPolicyResult deleteSecurityPolicy(DeleteSecurityPolicyRequest request)
```
    Deletes an OpenSearch Serverless security policy.
    
    Specified by:
    
    deleteSecurityPolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    deleteSecurityPolicyRequest -
    
    Returns:
    
    Result of the DeleteSecurityPolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - deleteVpcEndpoint
```
public DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest request)
```
    Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
    
    Specified by:
    
    deleteVpcEndpoint in interface AWSOpenSearchServerless
    
    Parameters:
    
    deleteVpcEndpointRequest -
    
    Returns:
    
    Result of the DeleteVpcEndpoint operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - getAccessPolicy
```
public GetAccessPolicyResult getAccessPolicy(GetAccessPolicyRequest request)
```
    Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
    
    Specified by:
    
    getAccessPolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    getAccessPolicyRequest -
    
    Returns:
    
    Result of the GetAccessPolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - getAccountSettings
```
public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
```
    Returns account-level settings related to OpenSearch Serverless.
    
    Specified by:
    
    getAccountSettings in interface AWSOpenSearchServerless
    
    Parameters:
    
    getAccountSettingsRequest -
    
    Returns:
    
    Result of the GetAccountSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - getPoliciesStats
```
public GetPoliciesStatsResult getPoliciesStats(GetPoliciesStatsRequest request)
```
    Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
    
    Specified by:
    
    getPoliciesStats in interface AWSOpenSearchServerless
    
    Parameters:
    
    getPoliciesStatsRequest -
    
    Returns:
    
    Result of the GetPoliciesStats operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    See Also:
    
    AWS API Documentation
  - getSecurityConfig
```
public GetSecurityConfigResult getSecurityConfig(GetSecurityConfigRequest request)
```
    Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.
    
    Specified by:
    
    getSecurityConfig in interface AWSOpenSearchServerless
    
    Parameters:
    
    getSecurityConfigRequest -
    
    Returns:
    
    Result of the GetSecurityConfig operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - getSecurityPolicy
```
public GetSecurityPolicyResult getSecurityPolicy(GetSecurityPolicyRequest request)
```
    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.
    
    Specified by:
    
    getSecurityPolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    getSecurityPolicyRequest -
    
    Returns:
    
    Result of the GetSecurityPolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - listAccessPolicies
```
public ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest request)
```
    Returns information about a list of OpenSearch Serverless access policies.
    
    Specified by:
    
    listAccessPolicies in interface AWSOpenSearchServerless
    
    Parameters:
    
    listAccessPoliciesRequest -
    
    Returns:
    
    Result of the ListAccessPolicies operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - listCollections
```
public ListCollectionsResult listCollections(ListCollectionsRequest request)
```
    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.
    
    Specified by:
    
    listCollections in interface AWSOpenSearchServerless
    
    Parameters:
    
    listCollectionsRequest -
    
    Returns:
    
    Result of the ListCollections operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - listLifecyclePolicies
```
public ListLifecyclePoliciesResult listLifecyclePolicies(ListLifecyclePoliciesRequest request)
```
    Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
    
    Specified by:
    
    listLifecyclePolicies in interface AWSOpenSearchServerless
    
    Parameters:
    
    listLifecyclePoliciesRequest -
    
    Returns:
    
    Result of the ListLifecyclePolicies operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - listSecurityConfigs
```
public ListSecurityConfigsResult listSecurityConfigs(ListSecurityConfigsRequest request)
```
    Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
    
    Specified by:
    
    listSecurityConfigs in interface AWSOpenSearchServerless
    
    Parameters:
    
    listSecurityConfigsRequest -
    
    Returns:
    
    Result of the ListSecurityConfigs operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - listSecurityPolicies
```
public ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest request)
```
    Returns information about configured OpenSearch Serverless security policies.
    
    Specified by:
    
    listSecurityPolicies in interface AWSOpenSearchServerless
    
    Parameters:
    
    listSecurityPoliciesRequest -
    
    Returns:
    
    Result of the ListSecurityPolicies operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
    
    Specified by:
    
    listTagsForResource in interface AWSOpenSearchServerless
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - listVpcEndpoints
```
public ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest request)
```
    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.
    
    Specified by:
    
    listVpcEndpoints in interface AWSOpenSearchServerless
    
    Parameters:
    
    listVpcEndpointsRequest -
    
    Returns:
    
    Result of the ListVpcEndpoints operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
    
    Specified by:
    
    tagResource in interface AWSOpenSearchServerless
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
    
    Specified by:
    
    untagResource in interface AWSOpenSearchServerless
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - updateAccessPolicy
```
public UpdateAccessPolicyResult updateAccessPolicy(UpdateAccessPolicyRequest request)
```
    Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
    
    Specified by:
    
    updateAccessPolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    updateAccessPolicyRequest -
    
    Returns:
    
    Result of the UpdateAccessPolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - updateAccountSettings
```
public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
```
    Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
    
    Specified by:
    
    updateAccountSettings in interface AWSOpenSearchServerless
    
    Parameters:
    
    updateAccountSettingsRequest -
    
    Returns:
    
    Result of the UpdateAccountSettings operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - updateCollection
```
public UpdateCollectionResult updateCollection(UpdateCollectionRequest request)
```
    Updates an OpenSearch Serverless collection.
    
    Specified by:
    
    updateCollection in interface AWSOpenSearchServerless
    
    Parameters:
    
    updateCollectionRequest -
    
    Returns:
    
    Result of the UpdateCollection operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - updateLifecyclePolicy
```
public UpdateLifecyclePolicyResult updateLifecyclePolicy(UpdateLifecyclePolicyRequest request)
```
    Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.
    
    Specified by:
    
    updateLifecyclePolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    updateLifecyclePolicyRequest -
    
    Returns:
    
    Result of the UpdateLifecyclePolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.
    
    See Also:
    
    AWS API Documentation
  - updateSecurityConfig
```
public UpdateSecurityConfigResult updateSecurityConfig(UpdateSecurityConfigRequest request)
```
    Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
    
    Specified by:
    
    updateSecurityConfig in interface AWSOpenSearchServerless
    
    Parameters:
    
    updateSecurityConfigRequest -
    
    Returns:
    
    Result of the UpdateSecurityConfig operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - updateSecurityPolicy
```
public UpdateSecurityPolicyResult updateSecurityPolicy(UpdateSecurityPolicyRequest request)
```
    Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
    
    Specified by:
    
    updateSecurityPolicy in interface AWSOpenSearchServerless
    
    Parameters:
    
    updateSecurityPolicyRequest -
    
    Returns:
    
    Result of the UpdateSecurityPolicy operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.
    
    See Also:
    
    AWS API Documentation
  - updateVpcEndpoint
```
public UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest request)
```
    Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
    
    Specified by:
    
    updateVpcEndpoint in interface AWSOpenSearchServerless
    
    Parameters:
    
    updateVpcEndpointRequest -
    
    Returns:
    
    Result of the UpdateVpcEndpoint operation returned by the service.
    
    Throws:
    
    InternalServerException - Thrown when an error internal to the service occurs while processing a request.
    
    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.
    
    ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSOpenSearchServerless
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSOpenSearchServerless
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class AWSOpenSearchServerlessClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.opensearchserverless.AWSOpenSearchServerless

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

batchGetCollection

batchGetEffectiveLifecyclePolicy

batchGetLifecyclePolicy

batchGetVpcEndpoint

createAccessPolicy

createCollection

createLifecyclePolicy

createSecurityConfig

createSecurityPolicy

createVpcEndpoint

deleteAccessPolicy

deleteCollection

deleteLifecyclePolicy

deleteSecurityConfig

deleteSecurityPolicy

deleteVpcEndpoint

getAccessPolicy

getAccountSettings

getPoliciesStats

getSecurityConfig

getSecurityPolicy

listAccessPolicies

listCollections

listLifecyclePolicies

listSecurityConfigs

listSecurityPolicies

listTagsForResource

listVpcEndpoints

tagResource

untagResource

updateAccessPolicy

updateAccountSettings

updateCollection

updateLifecyclePolicy

updateSecurityConfig

updateSecurityPolicy

updateVpcEndpoint

getCachedResponseMetadata

shutdown