com.amazonaws.services.opensearchserverless

Interface AWSOpenSearchServerless

All Known Subinterfaces:

AWSOpenSearchServerlessAsync

All Known Implementing Classes:

AbstractAWSOpenSearchServerless, AbstractAWSOpenSearchServerlessAsync, AWSOpenSearchServerlessAsyncClient, AWSOpenSearchServerlessClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSOpenSearchServerless

Interface for accessing OpenSearch Service Serverless.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from 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?

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchGetCollectionResult	batchGetCollection(BatchGetCollectionRequest batchGetCollectionRequest) Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint.
BatchGetEffectiveLifecyclePolicyResult	batchGetEffectiveLifecyclePolicy(BatchGetEffectiveLifecyclePolicyRequest batchGetEffectiveLifecyclePolicyRequest) Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes.
BatchGetLifecyclePolicyResult	batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest batchGetLifecyclePolicyRequest) Returns one or more configured OpenSearch Serverless lifecycle policies.
BatchGetVpcEndpointResult	batchGetVpcEndpoint(BatchGetVpcEndpointRequest batchGetVpcEndpointRequest) Returns attributes for one or more VPC endpoints associated with the current account.
CreateAccessPolicyResult	createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest) Creates a data access policy for OpenSearch Serverless.
CreateCollectionResult	createCollection(CreateCollectionRequest createCollectionRequest) Creates a new OpenSearch Serverless collection.
CreateLifecyclePolicyResult	createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest) Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.
CreateSecurityConfigResult	createSecurityConfig(CreateSecurityConfigRequest createSecurityConfigRequest) Specifies a security configuration for OpenSearch Serverless.
CreateSecurityPolicyResult	createSecurityPolicy(CreateSecurityPolicyRequest createSecurityPolicyRequest) Creates a security policy to be used by one or more OpenSearch Serverless collections.
CreateVpcEndpointResult	createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) Creates an OpenSearch Serverless-managed interface VPC endpoint.
DeleteAccessPolicyResult	deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest) Deletes an OpenSearch Serverless access policy.
DeleteCollectionResult	deleteCollection(DeleteCollectionRequest deleteCollectionRequest) Deletes an OpenSearch Serverless collection.
DeleteLifecyclePolicyResult	deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) Deletes an OpenSearch Serverless lifecycle policy.
DeleteSecurityConfigResult	deleteSecurityConfig(DeleteSecurityConfigRequest deleteSecurityConfigRequest) Deletes a security configuration for OpenSearch Serverless.
DeleteSecurityPolicyResult	deleteSecurityPolicy(DeleteSecurityPolicyRequest deleteSecurityPolicyRequest) Deletes an OpenSearch Serverless security policy.
DeleteVpcEndpointResult	deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest) Deletes an OpenSearch Serverless-managed interface endpoint.
GetAccessPolicyResult	getAccessPolicy(GetAccessPolicyRequest getAccessPolicyRequest) Returns an OpenSearch Serverless access policy.
GetAccountSettingsResult	getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest) 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 getPoliciesStatsRequest) Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
GetSecurityConfigResult	getSecurityConfig(GetSecurityConfigRequest getSecurityConfigRequest) Returns information about an OpenSearch Serverless security configuration.
GetSecurityPolicyResult	getSecurityPolicy(GetSecurityPolicyRequest getSecurityPolicyRequest) Returns information about a configured OpenSearch Serverless security policy.
ListAccessPoliciesResult	listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest) Returns information about a list of OpenSearch Serverless access policies.
ListCollectionsResult	listCollections(ListCollectionsRequest listCollectionsRequest) Lists all OpenSearch Serverless collections.
ListLifecyclePoliciesResult	listLifecyclePolicies(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest) Returns a list of OpenSearch Serverless lifecycle policies.
ListSecurityConfigsResult	listSecurityConfigs(ListSecurityConfigsRequest listSecurityConfigsRequest) Returns information about configured OpenSearch Serverless security configurations.
ListSecurityPoliciesResult	listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest) Returns information about configured OpenSearch Serverless security policies.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns the tags for an OpenSearch Serverless resource.
ListVpcEndpointsResult	listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest) 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 tagResourceRequest) Associates tags with an OpenSearch Serverless resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag or set of tags from an OpenSearch Serverless resource.
UpdateAccessPolicyResult	updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest) Updates an OpenSearch Serverless access policy.
UpdateAccountSettingsResult	updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) Update the OpenSearch Serverless settings for the current Amazon Web Services account.
UpdateCollectionResult	updateCollection(UpdateCollectionRequest updateCollectionRequest) Updates an OpenSearch Serverless collection.
UpdateLifecyclePolicyResult	updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest) Updates an OpenSearch Serverless access policy.
UpdateSecurityConfigResult	updateSecurityConfig(UpdateSecurityConfigRequest updateSecurityConfigRequest) Updates a security configuration for OpenSearch Serverless.
UpdateSecurityPolicyResult	updateSecurityPolicy(UpdateSecurityPolicyRequest updateSecurityPolicyRequest) Updates an OpenSearch Serverless security policy.
UpdateVpcEndpointResult	updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest) Updates an OpenSearch Serverless-managed interface endpoint.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchGetCollection

BatchGetCollectionResult batchGetCollection(BatchGetCollectionRequest batchGetCollectionRequest)

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.

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

BatchGetEffectiveLifecyclePolicyResult batchGetEffectiveLifecyclePolicy(BatchGetEffectiveLifecyclePolicyRequest batchGetEffectiveLifecyclePolicyRequest)

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.

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

BatchGetLifecyclePolicyResult batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest batchGetLifecyclePolicyRequest)

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

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

BatchGetVpcEndpointResult batchGetVpcEndpoint(BatchGetVpcEndpointRequest batchGetVpcEndpointRequest)

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.

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

CreateAccessPolicyResult createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)

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.

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

CreateCollectionResult createCollection(CreateCollectionRequest createCollectionRequest)

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

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

CreateLifecyclePolicyResult createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)

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.

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

CreateSecurityConfigResult createSecurityConfig(CreateSecurityConfigRequest createSecurityConfigRequest)

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

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

CreateSecurityPolicyResult createSecurityPolicy(CreateSecurityPolicyRequest createSecurityPolicyRequest)

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.

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

CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

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

DeleteAccessPolicyResult deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)

Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

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

DeleteCollectionResult deleteCollection(DeleteCollectionRequest deleteCollectionRequest)

Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

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

DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)

Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.

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

DeleteSecurityConfigResult deleteSecurityConfig(DeleteSecurityConfigRequest deleteSecurityConfigRequest)

Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

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

DeleteSecurityPolicyResult deleteSecurityPolicy(DeleteSecurityPolicyRequest deleteSecurityPolicyRequest)

Deletes an OpenSearch Serverless security policy.

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

DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)

Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

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

GetAccessPolicyResult getAccessPolicy(GetAccessPolicyRequest getAccessPolicyRequest)

Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

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

GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)

Returns account-level settings related to OpenSearch Serverless.

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

GetPoliciesStatsResult getPoliciesStats(GetPoliciesStatsRequest getPoliciesStatsRequest)

Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

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

GetSecurityConfigResult getSecurityConfig(GetSecurityConfigRequest getSecurityConfigRequest)

Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.

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

GetSecurityPolicyResult getSecurityPolicy(GetSecurityPolicyRequest getSecurityPolicyRequest)

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.

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

ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)

Returns information about a list of OpenSearch Serverless access policies.

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

ListCollectionsResult listCollections(ListCollectionsRequest 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.

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

ListLifecyclePoliciesResult listLifecyclePolicies(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

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

ListSecurityConfigsResult listSecurityConfigs(ListSecurityConfigsRequest listSecurityConfigsRequest)

Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.

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

ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)

Returns information about configured OpenSearch Serverless security policies.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

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

ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest 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.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

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

UpdateAccessPolicyResult updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)

Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

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

UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)

Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

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

UpdateCollectionResult updateCollection(UpdateCollectionRequest updateCollectionRequest)

Updates an OpenSearch Serverless collection.

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

UpdateLifecyclePolicyResult updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest)

Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.

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

UpdateSecurityConfigResult updateSecurityConfig(UpdateSecurityConfigRequest updateSecurityConfigRequest)

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

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

UpdateSecurityPolicyResult updateSecurityPolicy(UpdateSecurityPolicyRequest updateSecurityPolicyRequest)

Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

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

UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)

Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.