Interface OpenSearchServerlessClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface OpenSearchServerlessClient
extends AwsClient

Service client for accessing OpenSearch Service Serverless. This can be created using the static builder() method.

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.

To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless?

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchGetCollectionResponse	batchGetCollection(Consumer<BatchGetCollectionRequest.Builder> batchGetCollectionRequest)	Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint.
default BatchGetCollectionResponse	batchGetCollection(BatchGetCollectionRequest batchGetCollectionRequest)	Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint.
default BatchGetEffectiveLifecyclePolicyResponse	batchGetEffectiveLifecyclePolicy(Consumer<BatchGetEffectiveLifecyclePolicyRequest.Builder> batchGetEffectiveLifecyclePolicyRequest)	Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes.
default BatchGetEffectiveLifecyclePolicyResponse	batchGetEffectiveLifecyclePolicy(BatchGetEffectiveLifecyclePolicyRequest batchGetEffectiveLifecyclePolicyRequest)	Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes.
default BatchGetLifecyclePolicyResponse	batchGetLifecyclePolicy(Consumer<BatchGetLifecyclePolicyRequest.Builder> batchGetLifecyclePolicyRequest)	Returns one or more configured OpenSearch Serverless lifecycle policies.
default BatchGetLifecyclePolicyResponse	batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest batchGetLifecyclePolicyRequest)	Returns one or more configured OpenSearch Serverless lifecycle policies.
default BatchGetVpcEndpointResponse	batchGetVpcEndpoint(Consumer<BatchGetVpcEndpointRequest.Builder> batchGetVpcEndpointRequest)	Returns attributes for one or more VPC endpoints associated with the current account.
default BatchGetVpcEndpointResponse	batchGetVpcEndpoint(BatchGetVpcEndpointRequest batchGetVpcEndpointRequest)	Returns attributes for one or more VPC endpoints associated with the current account.
static OpenSearchServerlessClientBuilder	builder()	Create a builder that can be used to configure and create a OpenSearchServerlessClient.
static OpenSearchServerlessClient	create()	Create a OpenSearchServerlessClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAccessPolicyResponse	createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest)	Creates a data access policy for OpenSearch Serverless.
default CreateAccessPolicyResponse	createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)	Creates a data access policy for OpenSearch Serverless.
default CreateCollectionResponse	createCollection(Consumer<CreateCollectionRequest.Builder> createCollectionRequest)	Creates a new OpenSearch Serverless collection.
default CreateCollectionResponse	createCollection(CreateCollectionRequest createCollectionRequest)	Creates a new OpenSearch Serverless collection.
default CreateLifecyclePolicyResponse	createLifecyclePolicy(Consumer<CreateLifecyclePolicyRequest.Builder> createLifecyclePolicyRequest)	Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.
default CreateLifecyclePolicyResponse	createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)	Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.
default CreateSecurityConfigResponse	createSecurityConfig(Consumer<CreateSecurityConfigRequest.Builder> createSecurityConfigRequest)	Specifies a security configuration for OpenSearch Serverless.
default CreateSecurityConfigResponse	createSecurityConfig(CreateSecurityConfigRequest createSecurityConfigRequest)	Specifies a security configuration for OpenSearch Serverless.
default CreateSecurityPolicyResponse	createSecurityPolicy(Consumer<CreateSecurityPolicyRequest.Builder> createSecurityPolicyRequest)	Creates a security policy to be used by one or more OpenSearch Serverless collections.
default CreateSecurityPolicyResponse	createSecurityPolicy(CreateSecurityPolicyRequest createSecurityPolicyRequest)	Creates a security policy to be used by one or more OpenSearch Serverless collections.
default CreateVpcEndpointResponse	createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)	Creates an OpenSearch Serverless-managed interface VPC endpoint.
default CreateVpcEndpointResponse	createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)	Creates an OpenSearch Serverless-managed interface VPC endpoint.
default DeleteAccessPolicyResponse	deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest)	Deletes an OpenSearch Serverless access policy.
default DeleteAccessPolicyResponse	deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)	Deletes an OpenSearch Serverless access policy.
default DeleteCollectionResponse	deleteCollection(Consumer<DeleteCollectionRequest.Builder> deleteCollectionRequest)	Deletes an OpenSearch Serverless collection.
default DeleteCollectionResponse	deleteCollection(DeleteCollectionRequest deleteCollectionRequest)	Deletes an OpenSearch Serverless collection.
default DeleteLifecyclePolicyResponse	deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)	Deletes an OpenSearch Serverless lifecycle policy.
default DeleteLifecyclePolicyResponse	deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)	Deletes an OpenSearch Serverless lifecycle policy.
default DeleteSecurityConfigResponse	deleteSecurityConfig(Consumer<DeleteSecurityConfigRequest.Builder> deleteSecurityConfigRequest)	Deletes a security configuration for OpenSearch Serverless.
default DeleteSecurityConfigResponse	deleteSecurityConfig(DeleteSecurityConfigRequest deleteSecurityConfigRequest)	Deletes a security configuration for OpenSearch Serverless.
default DeleteSecurityPolicyResponse	deleteSecurityPolicy(Consumer<DeleteSecurityPolicyRequest.Builder> deleteSecurityPolicyRequest)	Deletes an OpenSearch Serverless security policy.
default DeleteSecurityPolicyResponse	deleteSecurityPolicy(DeleteSecurityPolicyRequest deleteSecurityPolicyRequest)	Deletes an OpenSearch Serverless security policy.
default DeleteVpcEndpointResponse	deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)	Deletes an OpenSearch Serverless-managed interface endpoint.
default DeleteVpcEndpointResponse	deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)	Deletes an OpenSearch Serverless-managed interface endpoint.
default GetAccessPolicyResponse	getAccessPolicy(Consumer<GetAccessPolicyRequest.Builder> getAccessPolicyRequest)	Returns an OpenSearch Serverless access policy.
default GetAccessPolicyResponse	getAccessPolicy(GetAccessPolicyRequest getAccessPolicyRequest)	Returns an OpenSearch Serverless access policy.
default GetAccountSettingsResponse	getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)	Returns account-level settings related to OpenSearch Serverless.
default GetAccountSettingsResponse	getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)	Returns account-level settings related to OpenSearch Serverless.
default GetPoliciesStatsResponse	getPoliciesStats(Consumer<GetPoliciesStatsRequest.Builder> getPoliciesStatsRequest)	Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
default GetPoliciesStatsResponse	getPoliciesStats(GetPoliciesStatsRequest getPoliciesStatsRequest)	Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
default GetSecurityConfigResponse	getSecurityConfig(Consumer<GetSecurityConfigRequest.Builder> getSecurityConfigRequest)	Returns information about an OpenSearch Serverless security configuration.
default GetSecurityConfigResponse	getSecurityConfig(GetSecurityConfigRequest getSecurityConfigRequest)	Returns information about an OpenSearch Serverless security configuration.
default GetSecurityPolicyResponse	getSecurityPolicy(Consumer<GetSecurityPolicyRequest.Builder> getSecurityPolicyRequest)	Returns information about a configured OpenSearch Serverless security policy.
default GetSecurityPolicyResponse	getSecurityPolicy(GetSecurityPolicyRequest getSecurityPolicyRequest)	Returns information about a configured OpenSearch Serverless security policy.
default ListAccessPoliciesResponse	listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)	Returns information about a list of OpenSearch Serverless access policies.
default ListAccessPoliciesResponse	listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)	Returns information about a list of OpenSearch Serverless access policies.
default ListAccessPoliciesIterable	listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)	This is a variant of listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest) operation.
default ListAccessPoliciesIterable	listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)	This is a variant of listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest) operation.
default ListCollectionsResponse	listCollections(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)	Lists all OpenSearch Serverless collections.
default ListCollectionsResponse	listCollections(ListCollectionsRequest listCollectionsRequest)	Lists all OpenSearch Serverless collections.
default ListCollectionsIterable	listCollectionsPaginator(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)	This is a variant of listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest) operation.
default ListCollectionsIterable	listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)	This is a variant of listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest) operation.
default ListLifecyclePoliciesResponse	listLifecyclePolicies(Consumer<ListLifecyclePoliciesRequest.Builder> listLifecyclePoliciesRequest)	Returns a list of OpenSearch Serverless lifecycle policies.
default ListLifecyclePoliciesResponse	listLifecyclePolicies(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)	Returns a list of OpenSearch Serverless lifecycle policies.
default ListLifecyclePoliciesIterable	listLifecyclePoliciesPaginator(Consumer<ListLifecyclePoliciesRequest.Builder> listLifecyclePoliciesRequest)	This is a variant of listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest) operation.
default ListLifecyclePoliciesIterable	listLifecyclePoliciesPaginator(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)	This is a variant of listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest) operation.
default ListSecurityConfigsResponse	listSecurityConfigs(Consumer<ListSecurityConfigsRequest.Builder> listSecurityConfigsRequest)	Returns information about configured OpenSearch Serverless security configurations.
default ListSecurityConfigsResponse	listSecurityConfigs(ListSecurityConfigsRequest listSecurityConfigsRequest)	Returns information about configured OpenSearch Serverless security configurations.
default ListSecurityConfigsIterable	listSecurityConfigsPaginator(Consumer<ListSecurityConfigsRequest.Builder> listSecurityConfigsRequest)	This is a variant of listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest) operation.
default ListSecurityConfigsIterable	listSecurityConfigsPaginator(ListSecurityConfigsRequest listSecurityConfigsRequest)	This is a variant of listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest) operation.
default ListSecurityPoliciesResponse	listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)	Returns information about configured OpenSearch Serverless security policies.
default ListSecurityPoliciesResponse	listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)	Returns information about configured OpenSearch Serverless security policies.
default ListSecurityPoliciesIterable	listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)	This is a variant of listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest) operation.
default ListSecurityPoliciesIterable	listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)	This is a variant of listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns the tags for an OpenSearch Serverless resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns the tags for an OpenSearch Serverless resource.
default ListVpcEndpointsResponse	listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)	Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
default ListVpcEndpointsResponse	listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)	Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
default ListVpcEndpointsIterable	listVpcEndpointsPaginator(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)	This is a variant of listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest) operation.
default ListVpcEndpointsIterable	listVpcEndpointsPaginator(ListVpcEndpointsRequest listVpcEndpointsRequest)	This is a variant of listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest) operation.
default OpenSearchServerlessServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Associates tags with an OpenSearch Serverless resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Associates tags with an OpenSearch Serverless resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes a tag or set of tags from an OpenSearch Serverless resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes a tag or set of tags from an OpenSearch Serverless resource.
default UpdateAccessPolicyResponse	updateAccessPolicy(Consumer<UpdateAccessPolicyRequest.Builder> updateAccessPolicyRequest)	Updates an OpenSearch Serverless access policy.
default UpdateAccessPolicyResponse	updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)	Updates an OpenSearch Serverless access policy.
default UpdateAccountSettingsResponse	updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)	Update the OpenSearch Serverless settings for the current Amazon Web Services account.
default UpdateAccountSettingsResponse	updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)	Update the OpenSearch Serverless settings for the current Amazon Web Services account.
default UpdateCollectionResponse	updateCollection(Consumer<UpdateCollectionRequest.Builder> updateCollectionRequest)	Updates an OpenSearch Serverless collection.
default UpdateCollectionResponse	updateCollection(UpdateCollectionRequest updateCollectionRequest)	Updates an OpenSearch Serverless collection.
default UpdateLifecyclePolicyResponse	updateLifecyclePolicy(Consumer<UpdateLifecyclePolicyRequest.Builder> updateLifecyclePolicyRequest)	Updates an OpenSearch Serverless access policy.
default UpdateLifecyclePolicyResponse	updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest)	Updates an OpenSearch Serverless access policy.
default UpdateSecurityConfigResponse	updateSecurityConfig(Consumer<UpdateSecurityConfigRequest.Builder> updateSecurityConfigRequest)	Updates a security configuration for OpenSearch Serverless.
default UpdateSecurityConfigResponse	updateSecurityConfig(UpdateSecurityConfigRequest updateSecurityConfigRequest)	Updates a security configuration for OpenSearch Serverless.
default UpdateSecurityPolicyResponse	updateSecurityPolicy(Consumer<UpdateSecurityPolicyRequest.Builder> updateSecurityPolicyRequest)	Updates an OpenSearch Serverless security policy.
default UpdateSecurityPolicyResponse	updateSecurityPolicy(UpdateSecurityPolicyRequest updateSecurityPolicyRequest)	Updates an OpenSearch Serverless security policy.
default UpdateVpcEndpointResponse	updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)	Updates an OpenSearch Serverless-managed interface endpoint.
default UpdateVpcEndpointResponse	updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)	Updates an OpenSearch Serverless-managed interface endpoint.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

batchGetCollection

default BatchGetCollectionResponse batchGetCollection(BatchGetCollectionRequest batchGetCollectionRequest)
                                               throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

batchGetCollection

default BatchGetCollectionResponse batchGetCollection(Consumer<BatchGetCollectionRequest.Builder> batchGetCollectionRequest)
                                               throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

This is a convenience which creates an instance of the BatchGetCollectionRequest.Builder avoiding the need to create one manually via BatchGetCollectionRequest.builder()

Parameters:

batchGetCollectionRequest - A Consumer that will call methods on BatchGetCollectionRequest.Builder to create a request.

Returns:

Result of the BatchGetCollection operation returned by the service.

See Also:

• AWS API Documentation

batchGetEffectiveLifecyclePolicy

default BatchGetEffectiveLifecyclePolicyResponse batchGetEffectiveLifecyclePolicy(BatchGetEffectiveLifecyclePolicyRequest batchGetEffectiveLifecyclePolicyRequest)
                                                                           throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

batchGetEffectiveLifecyclePolicy

default BatchGetEffectiveLifecyclePolicyResponse batchGetEffectiveLifecyclePolicy(Consumer<BatchGetEffectiveLifecyclePolicyRequest.Builder> batchGetEffectiveLifecyclePolicyRequest)
                                                                           throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the BatchGetEffectiveLifecyclePolicyRequest.Builder avoiding the need to create one manually via BatchGetEffectiveLifecyclePolicyRequest.builder()

Parameters:

batchGetEffectiveLifecyclePolicyRequest - A Consumer that will call methods on BatchGetEffectiveLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the BatchGetEffectiveLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

batchGetLifecyclePolicy

default BatchGetLifecyclePolicyResponse batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest batchGetLifecyclePolicyRequest)
                                                         throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

batchGetLifecyclePolicy

default BatchGetLifecyclePolicyResponse batchGetLifecyclePolicy(Consumer<BatchGetLifecyclePolicyRequest.Builder> batchGetLifecyclePolicyRequest)
                                                         throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the BatchGetLifecyclePolicyRequest.Builder avoiding the need to create one manually via BatchGetLifecyclePolicyRequest.builder()

Parameters:

batchGetLifecyclePolicyRequest - A Consumer that will call methods on BatchGetLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the BatchGetLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

batchGetVpcEndpoint

default BatchGetVpcEndpointResponse batchGetVpcEndpoint(BatchGetVpcEndpointRequest batchGetVpcEndpointRequest)
                                                 throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

batchGetVpcEndpoint

default BatchGetVpcEndpointResponse batchGetVpcEndpoint(Consumer<BatchGetVpcEndpointRequest.Builder> batchGetVpcEndpointRequest)
                                                 throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

This is a convenience which creates an instance of the BatchGetVpcEndpointRequest.Builder avoiding the need to create one manually via BatchGetVpcEndpointRequest.builder()

Parameters:

batchGetVpcEndpointRequest - A Consumer that will call methods on BatchGetVpcEndpointRequest.Builder to create a request.

Returns:

Result of the BatchGetVpcEndpoint operation returned by the service.

See Also:

• AWS API Documentation

createAccessPolicy

default CreateAccessPolicyResponse createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)
                                               throws InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

createAccessPolicy

default CreateAccessPolicyResponse createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest)
                                               throws InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.

This is a convenience which creates an instance of the CreateAccessPolicyRequest.Builder avoiding the need to create one manually via CreateAccessPolicyRequest.builder()

Parameters:

createAccessPolicyRequest - A Consumer that will call methods on CreateAccessPolicyRequest.Builder to create a request.

Returns:

Result of the CreateAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

createCollection

default CreateCollectionResponse createCollection(CreateCollectionRequest createCollectionRequest)
                                           throws OcuLimitExceededException,
InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

createCollection

default CreateCollectionResponse createCollection(Consumer<CreateCollectionRequest.Builder> createCollectionRequest)
                                           throws OcuLimitExceededException,
InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the CreateCollectionRequest.Builder avoiding the need to create one manually via CreateCollectionRequest.builder()

Parameters:

createCollectionRequest - A Consumer that will call methods on CreateCollectionRequest.Builder to create a request.

Returns:

Result of the CreateCollection operation returned by the service.

See Also:

• AWS API Documentation

createLifecyclePolicy

default CreateLifecyclePolicyResponse createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)
                                                     throws InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

createLifecyclePolicy

default CreateLifecyclePolicyResponse createLifecyclePolicy(Consumer<CreateLifecyclePolicyRequest.Builder> createLifecyclePolicyRequest)
                                                     throws InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.

This is a convenience which creates an instance of the CreateLifecyclePolicyRequest.Builder avoiding the need to create one manually via CreateLifecyclePolicyRequest.builder()

Parameters:

createLifecyclePolicyRequest - A Consumer that will call methods on CreateLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the CreateLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

createSecurityConfig

default CreateSecurityConfigResponse createSecurityConfig(CreateSecurityConfigRequest createSecurityConfigRequest)
                                                   throws InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

createSecurityConfig

default CreateSecurityConfigResponse createSecurityConfig(Consumer<CreateSecurityConfigRequest.Builder> createSecurityConfigRequest)
                                                   throws InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the CreateSecurityConfigRequest.Builder avoiding the need to create one manually via CreateSecurityConfigRequest.builder()

Parameters:

createSecurityConfigRequest - A Consumer that will call methods on CreateSecurityConfigRequest.Builder to create a request.

Returns:

Result of the CreateSecurityConfig operation returned by the service.

See Also:

• AWS API Documentation

createSecurityPolicy

default CreateSecurityPolicyResponse createSecurityPolicy(CreateSecurityPolicyRequest createSecurityPolicyRequest)
                                                   throws InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

createSecurityPolicy

default CreateSecurityPolicyResponse createSecurityPolicy(Consumer<CreateSecurityPolicyRequest.Builder> createSecurityPolicyRequest)
                                                   throws InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

This is a convenience which creates an instance of the CreateSecurityPolicyRequest.Builder avoiding the need to create one manually via CreateSecurityPolicyRequest.builder()

Parameters:

createSecurityPolicyRequest - A Consumer that will call methods on CreateSecurityPolicyRequest.Builder to create a request.

Returns:

Result of the CreateSecurityPolicy operation returned by the service.

See Also:

• AWS API Documentation

createVpcEndpoint

default CreateVpcEndpointResponse createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)
                                             throws InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

createVpcEndpoint

default CreateVpcEndpointResponse createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)
                                             throws InternalServerException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the CreateVpcEndpointRequest.Builder avoiding the need to create one manually via CreateVpcEndpointRequest.builder()

Parameters:

createVpcEndpointRequest - A Consumer that will call methods on CreateVpcEndpointRequest.Builder to create a request.

Returns:

Result of the CreateVpcEndpoint operation returned by the service.

See Also:

• AWS API Documentation

deleteAccessPolicy

default DeleteAccessPolicyResponse deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

deleteAccessPolicy

default DeleteAccessPolicyResponse deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the DeleteAccessPolicyRequest.Builder avoiding the need to create one manually via DeleteAccessPolicyRequest.builder()

Parameters:

deleteAccessPolicyRequest - A Consumer that will call methods on DeleteAccessPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteCollection

default DeleteCollectionResponse deleteCollection(DeleteCollectionRequest deleteCollectionRequest)
                                           throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

deleteCollection

default DeleteCollectionResponse deleteCollection(Consumer<DeleteCollectionRequest.Builder> deleteCollectionRequest)
                                           throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the DeleteCollectionRequest.Builder avoiding the need to create one manually via DeleteCollectionRequest.builder()

Parameters:

deleteCollectionRequest - A Consumer that will call methods on DeleteCollectionRequest.Builder to create a request.

Returns:

Result of the DeleteCollection operation returned by the service.

See Also:

• AWS API Documentation

deleteLifecyclePolicy

default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
                                                     throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

deleteLifecyclePolicy

default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)
                                                     throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the DeleteLifecyclePolicyRequest.Builder avoiding the need to create one manually via DeleteLifecyclePolicyRequest.builder()

Parameters:

deleteLifecyclePolicyRequest - A Consumer that will call methods on DeleteLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the DeleteLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteSecurityConfig

default DeleteSecurityConfigResponse deleteSecurityConfig(DeleteSecurityConfigRequest deleteSecurityConfigRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

deleteSecurityConfig

default DeleteSecurityConfigResponse deleteSecurityConfig(Consumer<DeleteSecurityConfigRequest.Builder> deleteSecurityConfigRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the DeleteSecurityConfigRequest.Builder avoiding the need to create one manually via DeleteSecurityConfigRequest.builder()

Parameters:

deleteSecurityConfigRequest - A Consumer that will call methods on DeleteSecurityConfigRequest.Builder to create a request.

Returns:

Result of the DeleteSecurityConfig operation returned by the service.

See Also:

• AWS API Documentation

deleteSecurityPolicy

default DeleteSecurityPolicyResponse deleteSecurityPolicy(DeleteSecurityPolicyRequest deleteSecurityPolicyRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Deletes an OpenSearch Serverless security policy.

Parameters:

deleteSecurityPolicyRequest -

Returns:

Result of the DeleteSecurityPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteSecurityPolicy

default DeleteSecurityPolicyResponse deleteSecurityPolicy(Consumer<DeleteSecurityPolicyRequest.Builder> deleteSecurityPolicyRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Deletes an OpenSearch Serverless security policy.

This is a convenience which creates an instance of the DeleteSecurityPolicyRequest.Builder avoiding the need to create one manually via DeleteSecurityPolicyRequest.builder()

Parameters:

deleteSecurityPolicyRequest - A Consumer that will call methods on DeleteSecurityPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteSecurityPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteVpcEndpoint

default DeleteVpcEndpointResponse deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

deleteVpcEndpoint

default DeleteVpcEndpointResponse deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the DeleteVpcEndpointRequest.Builder avoiding the need to create one manually via DeleteVpcEndpointRequest.builder()

Parameters:

deleteVpcEndpointRequest - A Consumer that will call methods on DeleteVpcEndpointRequest.Builder to create a request.

Returns:

Result of the DeleteVpcEndpoint operation returned by the service.

See Also:

• AWS API Documentation

getAccessPolicy

default GetAccessPolicyResponse getAccessPolicy(GetAccessPolicyRequest getAccessPolicyRequest)
                                         throws InternalServerException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

getAccessPolicy

default GetAccessPolicyResponse getAccessPolicy(Consumer<GetAccessPolicyRequest.Builder> getAccessPolicyRequest)
                                         throws InternalServerException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the GetAccessPolicyRequest.Builder avoiding the need to create one manually via GetAccessPolicyRequest.builder()

Parameters:

getAccessPolicyRequest - A Consumer that will call methods on GetAccessPolicyRequest.Builder to create a request.

Returns:

Result of the GetAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

getAccountSettings

default GetAccountSettingsResponse getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
                                               throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Returns account-level settings related to OpenSearch Serverless.

Parameters:

getAccountSettingsRequest -

Returns:

Result of the GetAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

getAccountSettings

default GetAccountSettingsResponse getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)
                                               throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Returns account-level settings related to OpenSearch Serverless.

This is a convenience which creates an instance of the GetAccountSettingsRequest.Builder avoiding the need to create one manually via GetAccountSettingsRequest.builder()

Parameters:

getAccountSettingsRequest - A Consumer that will call methods on GetAccountSettingsRequest.Builder to create a request.

Returns:

Result of the GetAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

getPoliciesStats

default GetPoliciesStatsResponse getPoliciesStats(GetPoliciesStatsRequest getPoliciesStatsRequest)
                                           throws InternalServerException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

getPoliciesStats

default GetPoliciesStatsResponse getPoliciesStats(Consumer<GetPoliciesStatsRequest.Builder> getPoliciesStatsRequest)
                                           throws InternalServerException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the GetPoliciesStatsRequest.Builder avoiding the need to create one manually via GetPoliciesStatsRequest.builder()

Parameters:

getPoliciesStatsRequest - A Consumer that will call methods on GetPoliciesStatsRequest.Builder to create a request.

Returns:

Result of the GetPoliciesStats operation returned by the service.

See Also:

• AWS API Documentation

getSecurityConfig

default GetSecurityConfigResponse getSecurityConfig(GetSecurityConfigRequest getSecurityConfigRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

getSecurityConfig

default GetSecurityConfigResponse getSecurityConfig(Consumer<GetSecurityConfigRequest.Builder> getSecurityConfigRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the GetSecurityConfigRequest.Builder avoiding the need to create one manually via GetSecurityConfigRequest.builder()

Parameters:

getSecurityConfigRequest - A Consumer that will call methods on GetSecurityConfigRequest.Builder to create a request.

Returns:

Result of the GetSecurityConfig operation returned by the service.

See Also:

• AWS API Documentation

getSecurityPolicy

default GetSecurityPolicyResponse getSecurityPolicy(GetSecurityPolicyRequest getSecurityPolicyRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

getSecurityPolicy

default GetSecurityPolicyResponse getSecurityPolicy(Consumer<GetSecurityPolicyRequest.Builder> getSecurityPolicyRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

This is a convenience which creates an instance of the GetSecurityPolicyRequest.Builder avoiding the need to create one manually via GetSecurityPolicyRequest.builder()

Parameters:

getSecurityPolicyRequest - A Consumer that will call methods on GetSecurityPolicyRequest.Builder to create a request.

Returns:

Result of the GetSecurityPolicy operation returned by the service.

See Also:

• AWS API Documentation

listAccessPolicies

default ListAccessPoliciesResponse listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
                                               throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Returns information about a list of OpenSearch Serverless access policies.

Parameters:

listAccessPoliciesRequest -

Returns:

Result of the ListAccessPolicies operation returned by the service.

See Also:

• AWS API Documentation

listAccessPolicies

default ListAccessPoliciesResponse listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)
                                               throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Returns information about a list of OpenSearch Serverless access policies.

This is a convenience which creates an instance of the ListAccessPoliciesRequest.Builder avoiding the need to create one manually via ListAccessPoliciesRequest.builder()

Parameters:

listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a request.

Returns:

Result of the ListAccessPolicies operation returned by the service.

See Also:

• AWS API Documentation

listAccessPoliciesPaginator

default ListAccessPoliciesIterable listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)
                                                        throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client
             .listAccessPoliciesPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest) operation.

Parameters:

listAccessPoliciesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAccessPoliciesPaginator

default ListAccessPoliciesIterable listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)
                                                        throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client
             .listAccessPoliciesPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesIterable responses = client.listAccessPoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAccessPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesRequest) operation.

This is a convenience which creates an instance of the ListAccessPoliciesRequest.Builder avoiding the need to create one manually via ListAccessPoliciesRequest.builder()

Parameters:

listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCollections

default ListCollectionsResponse listCollections(ListCollectionsRequest listCollectionsRequest)
                                         throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

listCollections

default ListCollectionsResponse listCollections(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)
                                         throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Make sure to include an empty request body {} if you don't include any collection filters in the request.

This is a convenience which creates an instance of the ListCollectionsRequest.Builder avoiding the need to create one manually via ListCollectionsRequest.builder()

Parameters:

listCollectionsRequest - A Consumer that will call methods on ListCollectionsRequest.Builder to create a request.

Returns:

Result of the ListCollections operation returned by the service.

See Also:

• AWS API Documentation

listCollectionsPaginator

default ListCollectionsIterable listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)
                                                  throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client
             .listCollectionsPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest) operation.

Parameters:

listCollectionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCollectionsPaginator

default ListCollectionsIterable listCollectionsPaginator(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)
                                                  throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client
             .listCollectionsPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsIterable responses = client.listCollectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest) operation.

This is a convenience which creates an instance of the ListCollectionsRequest.Builder avoiding the need to create one manually via ListCollectionsRequest.builder()

Parameters:

listCollectionsRequest - A Consumer that will call methods on ListCollectionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listLifecyclePolicies

default ListLifecyclePoliciesResponse listLifecyclePolicies(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)
                                                     throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

listLifecyclePolicies

default ListLifecyclePoliciesResponse listLifecyclePolicies(Consumer<ListLifecyclePoliciesRequest.Builder> listLifecyclePoliciesRequest)
                                                     throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the ListLifecyclePoliciesRequest.Builder avoiding the need to create one manually via ListLifecyclePoliciesRequest.builder()

Parameters:

listLifecyclePoliciesRequest - A Consumer that will call methods on ListLifecyclePoliciesRequest.Builder to create a request.

Returns:

Result of the ListLifecyclePolicies operation returned by the service.

See Also:

• AWS API Documentation

listLifecyclePoliciesPaginator

default ListLifecyclePoliciesIterable listLifecyclePoliciesPaginator(ListLifecyclePoliciesRequest listLifecyclePoliciesRequest)
                                                              throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client
             .listLifecyclePoliciesPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest) operation.

Parameters:

listLifecyclePoliciesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listLifecyclePoliciesPaginator

default ListLifecyclePoliciesIterable listLifecyclePoliciesPaginator(Consumer<ListLifecyclePoliciesRequest.Builder> listLifecyclePoliciesRequest)
                                                              throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client
             .listLifecyclePoliciesPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListLifecyclePoliciesIterable responses = client.listLifecyclePoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLifecyclePolicies(software.amazon.awssdk.services.opensearchserverless.model.ListLifecyclePoliciesRequest) operation.

This is a convenience which creates an instance of the ListLifecyclePoliciesRequest.Builder avoiding the need to create one manually via ListLifecyclePoliciesRequest.builder()

Parameters:

listLifecyclePoliciesRequest - A Consumer that will call methods on ListLifecyclePoliciesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSecurityConfigs

default ListSecurityConfigsResponse listSecurityConfigs(ListSecurityConfigsRequest listSecurityConfigsRequest)
                                                 throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

listSecurityConfigs

default ListSecurityConfigsResponse listSecurityConfigs(Consumer<ListSecurityConfigsRequest.Builder> listSecurityConfigsRequest)
                                                 throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the ListSecurityConfigsRequest.Builder avoiding the need to create one manually via ListSecurityConfigsRequest.builder()

Parameters:

listSecurityConfigsRequest - A Consumer that will call methods on ListSecurityConfigsRequest.Builder to create a request.

Returns:

Result of the ListSecurityConfigs operation returned by the service.

See Also:

• AWS API Documentation

listSecurityConfigsPaginator

default ListSecurityConfigsIterable listSecurityConfigsPaginator(ListSecurityConfigsRequest listSecurityConfigsRequest)
                                                          throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client.listSecurityConfigsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client
             .listSecurityConfigsPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client.listSecurityConfigsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest) operation.

Parameters:

listSecurityConfigsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSecurityConfigsPaginator

default ListSecurityConfigsIterable listSecurityConfigsPaginator(Consumer<ListSecurityConfigsRequest.Builder> listSecurityConfigsRequest)
                                                          throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client.listSecurityConfigsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client
             .listSecurityConfigsPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsIterable responses = client.listSecurityConfigsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecurityConfigs(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsRequest) operation.

This is a convenience which creates an instance of the ListSecurityConfigsRequest.Builder avoiding the need to create one manually via ListSecurityConfigsRequest.builder()

Parameters:

listSecurityConfigsRequest - A Consumer that will call methods on ListSecurityConfigsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSecurityPolicies

default ListSecurityPoliciesResponse listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
                                                   throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Returns information about configured OpenSearch Serverless security policies.

Parameters:

listSecurityPoliciesRequest -

Returns:

Result of the ListSecurityPolicies operation returned by the service.

See Also:

• AWS API Documentation

listSecurityPolicies

default ListSecurityPoliciesResponse listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
                                                   throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Returns information about configured OpenSearch Serverless security policies.

This is a convenience which creates an instance of the ListSecurityPoliciesRequest.Builder avoiding the need to create one manually via ListSecurityPoliciesRequest.builder()

Parameters:

listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a request.

Returns:

Result of the ListSecurityPolicies operation returned by the service.

See Also:

• AWS API Documentation

listSecurityPoliciesPaginator

default ListSecurityPoliciesIterable listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
                                                            throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client
             .listSecurityPoliciesPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest) operation.

Parameters:

listSecurityPoliciesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSecurityPoliciesPaginator

default ListSecurityPoliciesIterable listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
                                                            throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client
             .listSecurityPoliciesPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesIterable responses = client.listSecurityPoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSecurityPolicies(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesRequest) operation.

This is a convenience which creates an instance of the ListSecurityPoliciesRequest.Builder avoiding the need to create one manually via ListSecurityPoliciesRequest.builder()

Parameters:

listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalServerException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listVpcEndpoints

default ListVpcEndpointsResponse listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)
                                           throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

listVpcEndpoints

default ListVpcEndpointsResponse listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)
                                           throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

This is a convenience which creates an instance of the ListVpcEndpointsRequest.Builder avoiding the need to create one manually via ListVpcEndpointsRequest.builder()

Parameters:

listVpcEndpointsRequest - A Consumer that will call methods on ListVpcEndpointsRequest.Builder to create a request.

Returns:

Result of the ListVpcEndpoints operation returned by the service.

See Also:

• AWS API Documentation

listVpcEndpointsPaginator

default ListVpcEndpointsIterable listVpcEndpointsPaginator(ListVpcEndpointsRequest listVpcEndpointsRequest)
                                                    throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client.listVpcEndpointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client
             .listVpcEndpointsPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client.listVpcEndpointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest) operation.

Parameters:

listVpcEndpointsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listVpcEndpointsPaginator

default ListVpcEndpointsIterable listVpcEndpointsPaginator(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)
                                                    throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

This is a variant of listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client.listVpcEndpointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client
             .listVpcEndpointsPaginator(request);
     for (software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsIterable responses = client.listVpcEndpointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest) operation.

This is a convenience which creates an instance of the ListVpcEndpointsRequest.Builder avoiding the need to create one manually via ListVpcEndpointsRequest.builder()

Parameters:

listVpcEndpointsRequest - A Consumer that will call methods on ListVpcEndpointsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateAccessPolicy

default UpdateAccessPolicyResponse updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

updateAccessPolicy

default UpdateAccessPolicyResponse updateAccessPolicy(Consumer<UpdateAccessPolicyRequest.Builder> updateAccessPolicyRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the UpdateAccessPolicyRequest.Builder avoiding the need to create one manually via UpdateAccessPolicyRequest.builder()

Parameters:

updateAccessPolicyRequest - A Consumer that will call methods on UpdateAccessPolicyRequest.Builder to create a request.

Returns:

Result of the UpdateAccessPolicy operation returned by the service.

See Also:

• AWS API Documentation

updateAccountSettings

default UpdateAccountSettingsResponse updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
                                                     throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

updateAccountSettings

default UpdateAccountSettingsResponse updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)
                                                     throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the UpdateAccountSettingsRequest.Builder avoiding the need to create one manually via UpdateAccountSettingsRequest.builder()

Parameters:

updateAccountSettingsRequest - A Consumer that will call methods on UpdateAccountSettingsRequest.Builder to create a request.

Returns:

Result of the UpdateAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

updateCollection

default UpdateCollectionResponse updateCollection(UpdateCollectionRequest updateCollectionRequest)
                                           throws InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Updates an OpenSearch Serverless collection.

Parameters:

updateCollectionRequest -

Returns:

Result of the UpdateCollection operation returned by the service.

See Also:

• AWS API Documentation

updateCollection

default UpdateCollectionResponse updateCollection(Consumer<UpdateCollectionRequest.Builder> updateCollectionRequest)
                                           throws InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

Updates an OpenSearch Serverless collection.

This is a convenience which creates an instance of the UpdateCollectionRequest.Builder avoiding the need to create one manually via UpdateCollectionRequest.builder()

Parameters:

updateCollectionRequest - A Consumer that will call methods on UpdateCollectionRequest.Builder to create a request.

Returns:

Result of the UpdateCollection operation returned by the service.

See Also:

• AWS API Documentation

updateLifecyclePolicy

default UpdateLifecyclePolicyResponse updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest)
                                                     throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

updateLifecyclePolicy

default UpdateLifecyclePolicyResponse updateLifecyclePolicy(Consumer<UpdateLifecyclePolicyRequest.Builder> updateLifecyclePolicyRequest)
                                                     throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the UpdateLifecyclePolicyRequest.Builder avoiding the need to create one manually via UpdateLifecyclePolicyRequest.builder()

Parameters:

updateLifecyclePolicyRequest - A Consumer that will call methods on UpdateLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the UpdateLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

updateSecurityConfig

default UpdateSecurityConfigResponse updateSecurityConfig(UpdateSecurityConfigRequest updateSecurityConfigRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

updateSecurityConfig

default UpdateSecurityConfigResponse updateSecurityConfig(Consumer<UpdateSecurityConfigRequest.Builder> updateSecurityConfigRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the UpdateSecurityConfigRequest.Builder avoiding the need to create one manually via UpdateSecurityConfigRequest.builder()

Parameters:

updateSecurityConfigRequest - A Consumer that will call methods on UpdateSecurityConfigRequest.Builder to create a request.

Returns:

Result of the UpdateSecurityConfig operation returned by the service.

See Also:

• AWS API Documentation

updateSecurityPolicy

default UpdateSecurityPolicyResponse updateSecurityPolicy(UpdateSecurityPolicyRequest updateSecurityPolicyRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

updateSecurityPolicy

default UpdateSecurityPolicyResponse updateSecurityPolicy(Consumer<UpdateSecurityPolicyRequest.Builder> updateSecurityPolicyRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
ConflictException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the UpdateSecurityPolicyRequest.Builder avoiding the need to create one manually via UpdateSecurityPolicyRequest.builder()

Parameters:

updateSecurityPolicyRequest - A Consumer that will call methods on UpdateSecurityPolicyRequest.Builder to create a request.

Returns:

Result of the UpdateSecurityPolicy operation returned by the service.

See Also:

• AWS API Documentation

updateVpcEndpoint

default UpdateVpcEndpointResponse updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)
                                             throws InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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.

See Also:

• AWS API Documentation

updateVpcEndpoint

default UpdateVpcEndpointResponse updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)
                                             throws InternalServerException,
ConflictException,
ValidationException,
AwsServiceException,
SdkClientException,
OpenSearchServerlessException

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

This is a convenience which creates an instance of the UpdateVpcEndpointRequest.Builder avoiding the need to create one manually via UpdateVpcEndpointRequest.builder()

Parameters:

updateVpcEndpointRequest - A Consumer that will call methods on UpdateVpcEndpointRequest.Builder to create a request.

Returns:

Result of the UpdateVpcEndpoint operation returned by the service.

See Also:

• AWS API Documentation

create

static OpenSearchServerlessClient create()

Create a OpenSearchServerlessClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static OpenSearchServerlessClientBuilder builder()

Create a builder that can be used to configure and create a OpenSearchServerlessClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default OpenSearchServerlessServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration