@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface OpenSearchServerlessClient extends AwsClient
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?
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default BatchGetCollectionResponse |
batchGetCollection(BatchGetCollectionRequest batchGetCollectionRequest)
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards
endpoint.
|
default BatchGetCollectionResponse |
batchGetCollection(Consumer<BatchGetCollectionRequest.Builder> batchGetCollectionRequest)
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards
endpoint.
|
default BatchGetVpcEndpointResponse |
batchGetVpcEndpoint(BatchGetVpcEndpointRequest batchGetVpcEndpointRequest)
Returns attributes for one or more VPC endpoints associated with the current account.
|
default BatchGetVpcEndpointResponse |
batchGetVpcEndpoint(Consumer<BatchGetVpcEndpointRequest.Builder> 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 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 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)
Returns information about a list of OpenSearch Serverless access policies.
|
default ListAccessPoliciesIterable |
listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)
Returns information about a list of OpenSearch Serverless access policies.
|
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)
Lists all OpenSearch Serverless collections.
|
default ListCollectionsIterable |
listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)
Lists all OpenSearch Serverless collections.
|
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)
Returns information about configured OpenSearch Serverless security configurations.
|
default ListSecurityConfigsIterable |
listSecurityConfigsPaginator(ListSecurityConfigsRequest listSecurityConfigsRequest)
Returns information about configured OpenSearch Serverless security configurations.
|
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)
Returns information about configured OpenSearch Serverless security policies.
|
default ListSecurityPoliciesIterable |
listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Returns information about configured OpenSearch Serverless security policies.
|
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)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
|
default ListVpcEndpointsIterable |
listVpcEndpointsPaginator(ListVpcEndpointsRequest listVpcEndpointsRequest)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
|
default OpenSearchServerlessServiceClientConfiguration |
serviceClientConfiguration() |
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 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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
batchGetCollectionRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
batchGetCollectionRequest - A Consumer that will call methods on BatchGetCollectionRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
batchGetVpcEndpointRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
batchGetVpcEndpointRequest - A Consumer that will call methods on BatchGetVpcEndpointRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createAccessPolicyRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createAccessPolicyRequest - A Consumer that will call methods on CreateAccessPolicyRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createCollectionRequest - OcuLimitExceededException - OCU Limit Exceeded for service limitsInternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createCollectionRequest - A Consumer that will call methods on CreateCollectionRequest.Builder to create a request.OcuLimitExceededException - OCU Limit Exceeded for service limitsInternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createSecurityConfigRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createSecurityConfigRequest - A Consumer that will call methods on CreateSecurityConfigRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createSecurityPolicyRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createSecurityPolicyRequest - A Consumer that will call methods on CreateSecurityPolicyRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createVpcEndpointRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
createVpcEndpointRequest - A Consumer that will call methods on CreateVpcEndpointRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteAccessPolicyRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
deleteAccessPolicyRequest - A Consumer that will call methods on DeleteAccessPolicyRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteCollectionRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
deleteCollectionRequest - A Consumer that will call methods on DeleteCollectionRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteSecurityConfigRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
deleteSecurityConfigRequest - A Consumer that will call methods on DeleteSecurityConfigRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSecurityPolicyResponse deleteSecurityPolicy(DeleteSecurityPolicyRequest deleteSecurityPolicyRequest) throws InternalServerException, ResourceNotFoundException, ConflictException, ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException
Deletes an OpenSearch Serverless security policy.
deleteSecurityPolicyRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
deleteSecurityPolicyRequest - A Consumer that will call methods on DeleteSecurityPolicyRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteVpcEndpointRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
deleteVpcEndpointRequest - A Consumer that will call methods on DeleteVpcEndpointRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getAccessPolicyRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getAccessPolicyRequest - A Consumer that will call methods on GetAccessPolicyRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountSettingsResponse getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException
Returns account-level settings related to OpenSearch Serverless.
getAccountSettingsRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getAccountSettingsRequest - A Consumer that will call methods on GetAccountSettingsRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPoliciesStatsResponse getPoliciesStats(GetPoliciesStatsRequest getPoliciesStatsRequest) throws InternalServerException, AwsServiceException, SdkClientException, OpenSearchServerlessException
Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
getPoliciesStatsRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getPoliciesStatsRequest - A Consumer that will call methods on GetPoliciesStatsRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getSecurityConfigRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getSecurityConfigRequest - A Consumer that will call methods on GetSecurityConfigRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getSecurityPolicyRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getSecurityPolicyRequest - A Consumer that will call methods on GetSecurityPolicyRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPoliciesResponse listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException
Returns information about a list of OpenSearch Serverless access policies.
listAccessPoliciesRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPoliciesIterable listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException
Returns information about a list of OpenSearch Serverless access policies.
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.
listAccessPoliciesRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListAccessPoliciesIterable listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException
Returns information about a list of OpenSearch Serverless access policies.
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()
listAccessPoliciesRequest - A Consumer that will call methods on ListAccessPoliciesRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listCollectionsRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listCollectionsRequest - A Consumer that will call methods on ListCollectionsRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCollectionsIterable listCollectionsPaginator(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.
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.
listCollectionsRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCollectionsIterable listCollectionsPaginator(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 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()
listCollectionsRequest - A Consumer that will call methods on ListCollectionsRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listSecurityConfigsRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listSecurityConfigsRequest - A Consumer that will call methods on ListSecurityConfigsRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityConfigsIterable listSecurityConfigsPaginator(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.
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.
listSecurityConfigsRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityConfigsIterable listSecurityConfigsPaginator(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 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()
listSecurityConfigsRequest - A Consumer that will call methods on ListSecurityConfigsRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityPoliciesResponse listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException
Returns information about configured OpenSearch Serverless security policies.
listSecurityPoliciesRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityPoliciesIterable listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException
Returns information about configured OpenSearch Serverless security policies.
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.
listSecurityPoliciesRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSecurityPoliciesIterable listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException
Returns information about configured OpenSearch Serverless security policies.
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()
listSecurityPoliciesRequest - A Consumer that will call methods on ListSecurityPoliciesRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listTagsForResourceRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listVpcEndpointsRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listVpcEndpointsRequest - A Consumer that will call methods on ListVpcEndpointsRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVpcEndpointsIterable listVpcEndpointsPaginator(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.
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.
listVpcEndpointsRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVpcEndpointsIterable listVpcEndpointsPaginator(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 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()
listVpcEndpointsRequest - A Consumer that will call methods on ListVpcEndpointsRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
tagResourceRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
untagResourceRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateAccessPolicyRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateAccessPolicyRequest - A Consumer that will call methods on UpdateAccessPolicyRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateAccountSettingsRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateAccountSettingsRequest - A Consumer that will call methods on UpdateAccountSettingsRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateCollectionResponse updateCollection(UpdateCollectionRequest updateCollectionRequest) throws InternalServerException, ConflictException, ValidationException, AwsServiceException, SdkClientException, OpenSearchServerlessException
Updates an OpenSearch Serverless collection.
updateCollectionRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateCollectionRequest - A Consumer that will call methods on UpdateCollectionRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateSecurityConfigRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateSecurityConfigRequest - A Consumer that will call methods on UpdateSecurityConfigRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateSecurityPolicyRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateSecurityPolicyRequest - A Consumer that will call methods on UpdateSecurityPolicyRequest.Builder to create a
request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ResourceNotFoundException - Thrown when accessing or deleting a resource that does not exist.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.ServiceQuotaExceededException - Thrown when you attempt to create more resources than the service allows based on service quotas.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateVpcEndpointRequest - InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
updateVpcEndpointRequest - A Consumer that will call methods on UpdateVpcEndpointRequest.Builder to create a request.InternalServerException - Thrown when an error internal to the service occurs while processing a request.ConflictException - When creating a resource, thrown when a resource with the same name already exists or is being created.
When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.ValidationException - Thrown when the HTTP request contains invalid input or is missing required input.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchServerlessException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic OpenSearchServerlessClient create()
OpenSearchServerlessClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static OpenSearchServerlessClientBuilder builder()
OpenSearchServerlessClient.static ServiceMetadata serviceMetadata()
default OpenSearchServerlessServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.