@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface OpenSearchServerlessAsyncClient 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 CompletableFuture<BatchGetCollectionResponse> |
batchGetCollection(BatchGetCollectionRequest batchGetCollectionRequest)
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards
endpoint.
|
default CompletableFuture<BatchGetCollectionResponse> |
batchGetCollection(Consumer<BatchGetCollectionRequest.Builder> batchGetCollectionRequest)
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards
endpoint.
|
default CompletableFuture<BatchGetVpcEndpointResponse> |
batchGetVpcEndpoint(BatchGetVpcEndpointRequest batchGetVpcEndpointRequest)
Returns attributes for one or more VPC endpoints associated with the current account.
|
default CompletableFuture<BatchGetVpcEndpointResponse> |
batchGetVpcEndpoint(Consumer<BatchGetVpcEndpointRequest.Builder> batchGetVpcEndpointRequest)
Returns attributes for one or more VPC endpoints associated with the current account.
|
static OpenSearchServerlessAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
OpenSearchServerlessAsyncClient. |
static OpenSearchServerlessAsyncClient |
create()
Create a
OpenSearchServerlessAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateAccessPolicyResponse> |
createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest)
Creates a data access policy for OpenSearch Serverless.
|
default CompletableFuture<CreateAccessPolicyResponse> |
createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)
Creates a data access policy for OpenSearch Serverless.
|
default CompletableFuture<CreateCollectionResponse> |
createCollection(Consumer<CreateCollectionRequest.Builder> createCollectionRequest)
Creates a new OpenSearch Serverless collection.
|
default CompletableFuture<CreateCollectionResponse> |
createCollection(CreateCollectionRequest createCollectionRequest)
Creates a new OpenSearch Serverless collection.
|
default CompletableFuture<CreateSecurityConfigResponse> |
createSecurityConfig(Consumer<CreateSecurityConfigRequest.Builder> createSecurityConfigRequest)
Specifies a security configuration for OpenSearch Serverless.
|
default CompletableFuture<CreateSecurityConfigResponse> |
createSecurityConfig(CreateSecurityConfigRequest createSecurityConfigRequest)
Specifies a security configuration for OpenSearch Serverless.
|
default CompletableFuture<CreateSecurityPolicyResponse> |
createSecurityPolicy(Consumer<CreateSecurityPolicyRequest.Builder> createSecurityPolicyRequest)
Creates a security policy to be used by one or more OpenSearch Serverless collections.
|
default CompletableFuture<CreateSecurityPolicyResponse> |
createSecurityPolicy(CreateSecurityPolicyRequest createSecurityPolicyRequest)
Creates a security policy to be used by one or more OpenSearch Serverless collections.
|
default CompletableFuture<CreateVpcEndpointResponse> |
createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)
Creates an OpenSearch Serverless-managed interface VPC endpoint.
|
default CompletableFuture<CreateVpcEndpointResponse> |
createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)
Creates an OpenSearch Serverless-managed interface VPC endpoint.
|
default CompletableFuture<DeleteAccessPolicyResponse> |
deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest)
Deletes an OpenSearch Serverless access policy.
|
default CompletableFuture<DeleteAccessPolicyResponse> |
deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
Deletes an OpenSearch Serverless access policy.
|
default CompletableFuture<DeleteCollectionResponse> |
deleteCollection(Consumer<DeleteCollectionRequest.Builder> deleteCollectionRequest)
Deletes an OpenSearch Serverless collection.
|
default CompletableFuture<DeleteCollectionResponse> |
deleteCollection(DeleteCollectionRequest deleteCollectionRequest)
Deletes an OpenSearch Serverless collection.
|
default CompletableFuture<DeleteSecurityConfigResponse> |
deleteSecurityConfig(Consumer<DeleteSecurityConfigRequest.Builder> deleteSecurityConfigRequest)
Deletes a security configuration for OpenSearch Serverless.
|
default CompletableFuture<DeleteSecurityConfigResponse> |
deleteSecurityConfig(DeleteSecurityConfigRequest deleteSecurityConfigRequest)
Deletes a security configuration for OpenSearch Serverless.
|
default CompletableFuture<DeleteSecurityPolicyResponse> |
deleteSecurityPolicy(Consumer<DeleteSecurityPolicyRequest.Builder> deleteSecurityPolicyRequest)
Deletes an OpenSearch Serverless security policy.
|
default CompletableFuture<DeleteSecurityPolicyResponse> |
deleteSecurityPolicy(DeleteSecurityPolicyRequest deleteSecurityPolicyRequest)
Deletes an OpenSearch Serverless security policy.
|
default CompletableFuture<DeleteVpcEndpointResponse> |
deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)
Deletes an OpenSearch Serverless-managed interface endpoint.
|
default CompletableFuture<DeleteVpcEndpointResponse> |
deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)
Deletes an OpenSearch Serverless-managed interface endpoint.
|
default CompletableFuture<GetAccessPolicyResponse> |
getAccessPolicy(Consumer<GetAccessPolicyRequest.Builder> getAccessPolicyRequest)
Returns an OpenSearch Serverless access policy.
|
default CompletableFuture<GetAccessPolicyResponse> |
getAccessPolicy(GetAccessPolicyRequest getAccessPolicyRequest)
Returns an OpenSearch Serverless access policy.
|
default CompletableFuture<GetAccountSettingsResponse> |
getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)
Returns account-level settings related to OpenSearch Serverless.
|
default CompletableFuture<GetAccountSettingsResponse> |
getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Returns account-level settings related to OpenSearch Serverless.
|
default CompletableFuture<GetPoliciesStatsResponse> |
getPoliciesStats(Consumer<GetPoliciesStatsRequest.Builder> getPoliciesStatsRequest)
Returns statistical information about your OpenSearch Serverless access policies, security configurations, and
security policies.
|
default CompletableFuture<GetPoliciesStatsResponse> |
getPoliciesStats(GetPoliciesStatsRequest getPoliciesStatsRequest)
Returns statistical information about your OpenSearch Serverless access policies, security configurations, and
security policies.
|
default CompletableFuture<GetSecurityConfigResponse> |
getSecurityConfig(Consumer<GetSecurityConfigRequest.Builder> getSecurityConfigRequest)
Returns information about an OpenSearch Serverless security configuration.
|
default CompletableFuture<GetSecurityConfigResponse> |
getSecurityConfig(GetSecurityConfigRequest getSecurityConfigRequest)
Returns information about an OpenSearch Serverless security configuration.
|
default CompletableFuture<GetSecurityPolicyResponse> |
getSecurityPolicy(Consumer<GetSecurityPolicyRequest.Builder> getSecurityPolicyRequest)
Returns information about a configured OpenSearch Serverless security policy.
|
default CompletableFuture<GetSecurityPolicyResponse> |
getSecurityPolicy(GetSecurityPolicyRequest getSecurityPolicyRequest)
Returns information about a configured OpenSearch Serverless security policy.
|
default CompletableFuture<ListAccessPoliciesResponse> |
listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)
Returns information about a list of OpenSearch Serverless access policies.
|
default CompletableFuture<ListAccessPoliciesResponse> |
listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
Returns information about a list of OpenSearch Serverless access policies.
|
default ListAccessPoliciesPublisher |
listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)
Returns information about a list of OpenSearch Serverless access policies.
|
default ListAccessPoliciesPublisher |
listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)
Returns information about a list of OpenSearch Serverless access policies.
|
default CompletableFuture<ListCollectionsResponse> |
listCollections(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)
Lists all OpenSearch Serverless collections.
|
default CompletableFuture<ListCollectionsResponse> |
listCollections(ListCollectionsRequest listCollectionsRequest)
Lists all OpenSearch Serverless collections.
|
default ListCollectionsPublisher |
listCollectionsPaginator(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)
Lists all OpenSearch Serverless collections.
|
default ListCollectionsPublisher |
listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)
Lists all OpenSearch Serverless collections.
|
default CompletableFuture<ListSecurityConfigsResponse> |
listSecurityConfigs(Consumer<ListSecurityConfigsRequest.Builder> listSecurityConfigsRequest)
Returns information about configured OpenSearch Serverless security configurations.
|
default CompletableFuture<ListSecurityConfigsResponse> |
listSecurityConfigs(ListSecurityConfigsRequest listSecurityConfigsRequest)
Returns information about configured OpenSearch Serverless security configurations.
|
default ListSecurityConfigsPublisher |
listSecurityConfigsPaginator(Consumer<ListSecurityConfigsRequest.Builder> listSecurityConfigsRequest)
Returns information about configured OpenSearch Serverless security configurations.
|
default ListSecurityConfigsPublisher |
listSecurityConfigsPaginator(ListSecurityConfigsRequest listSecurityConfigsRequest)
Returns information about configured OpenSearch Serverless security configurations.
|
default CompletableFuture<ListSecurityPoliciesResponse> |
listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
Returns information about configured OpenSearch Serverless security policies.
|
default CompletableFuture<ListSecurityPoliciesResponse> |
listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Returns information about configured OpenSearch Serverless security policies.
|
default ListSecurityPoliciesPublisher |
listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
Returns information about configured OpenSearch Serverless security policies.
|
default ListSecurityPoliciesPublisher |
listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Returns information about configured OpenSearch Serverless security policies.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns the tags for an OpenSearch Serverless resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns the tags for an OpenSearch Serverless resource.
|
default CompletableFuture<ListVpcEndpointsResponse> |
listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
|
default CompletableFuture<ListVpcEndpointsResponse> |
listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
|
default ListVpcEndpointsPublisher |
listVpcEndpointsPaginator(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
|
default ListVpcEndpointsPublisher |
listVpcEndpointsPaginator(ListVpcEndpointsRequest listVpcEndpointsRequest)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
|
default OpenSearchServerlessServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates tags with an OpenSearch Serverless resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Associates tags with an OpenSearch Serverless resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag or set of tags from an OpenSearch Serverless resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or set of tags from an OpenSearch Serverless resource.
|
default CompletableFuture<UpdateAccessPolicyResponse> |
updateAccessPolicy(Consumer<UpdateAccessPolicyRequest.Builder> updateAccessPolicyRequest)
Updates an OpenSearch Serverless access policy.
|
default CompletableFuture<UpdateAccessPolicyResponse> |
updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)
Updates an OpenSearch Serverless access policy.
|
default CompletableFuture<UpdateAccountSettingsResponse> |
updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)
Update the OpenSearch Serverless settings for the current Amazon Web Services account.
|
default CompletableFuture<UpdateAccountSettingsResponse> |
updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Update the OpenSearch Serverless settings for the current Amazon Web Services account.
|
default CompletableFuture<UpdateCollectionResponse> |
updateCollection(Consumer<UpdateCollectionRequest.Builder> updateCollectionRequest)
Updates an OpenSearch Serverless collection.
|
default CompletableFuture<UpdateCollectionResponse> |
updateCollection(UpdateCollectionRequest updateCollectionRequest)
Updates an OpenSearch Serverless collection.
|
default CompletableFuture<UpdateSecurityConfigResponse> |
updateSecurityConfig(Consumer<UpdateSecurityConfigRequest.Builder> updateSecurityConfigRequest)
Updates a security configuration for OpenSearch Serverless.
|
default CompletableFuture<UpdateSecurityConfigResponse> |
updateSecurityConfig(UpdateSecurityConfigRequest updateSecurityConfigRequest)
Updates a security configuration for OpenSearch Serverless.
|
default CompletableFuture<UpdateSecurityPolicyResponse> |
updateSecurityPolicy(Consumer<UpdateSecurityPolicyRequest.Builder> updateSecurityPolicyRequest)
Updates an OpenSearch Serverless security policy.
|
default CompletableFuture<UpdateSecurityPolicyResponse> |
updateSecurityPolicy(UpdateSecurityPolicyRequest updateSecurityPolicyRequest)
Updates an OpenSearch Serverless security policy.
|
default CompletableFuture<UpdateVpcEndpointResponse> |
updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)
Updates an OpenSearch Serverless-managed interface endpoint.
|
default CompletableFuture<UpdateVpcEndpointResponse> |
updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)
Updates an OpenSearch Serverless-managed interface endpoint.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<BatchGetCollectionResponse> batchGetCollection(BatchGetCollectionRequest batchGetCollectionRequest)
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
batchGetCollectionRequest - default CompletableFuture<BatchGetCollectionResponse> batchGetCollection(Consumer<BatchGetCollectionRequest.Builder> batchGetCollectionRequest)
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
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.default CompletableFuture<BatchGetVpcEndpointResponse> batchGetVpcEndpoint(BatchGetVpcEndpointRequest batchGetVpcEndpointRequest)
Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
batchGetVpcEndpointRequest - default CompletableFuture<BatchGetVpcEndpointResponse> batchGetVpcEndpoint(Consumer<BatchGetVpcEndpointRequest.Builder> batchGetVpcEndpointRequest)
Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
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.default CompletableFuture<CreateAccessPolicyResponse> createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)
Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.
createAccessPolicyRequest - default CompletableFuture<CreateAccessPolicyResponse> createAccessPolicy(Consumer<CreateAccessPolicyRequest.Builder> createAccessPolicyRequest)
Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.
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.default CompletableFuture<CreateCollectionResponse> createCollection(CreateCollectionRequest createCollectionRequest)
Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
createCollectionRequest - default CompletableFuture<CreateCollectionResponse> createCollection(Consumer<CreateCollectionRequest.Builder> createCollectionRequest)
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.default CompletableFuture<CreateSecurityConfigResponse> createSecurityConfig(CreateSecurityConfigRequest createSecurityConfigRequest)
Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
createSecurityConfigRequest - default CompletableFuture<CreateSecurityConfigResponse> createSecurityConfig(Consumer<CreateSecurityConfigRequest.Builder> createSecurityConfigRequest)
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.default CompletableFuture<CreateSecurityPolicyResponse> createSecurityPolicy(CreateSecurityPolicyRequest createSecurityPolicyRequest)
Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
createSecurityPolicyRequest - default CompletableFuture<CreateSecurityPolicyResponse> createSecurityPolicy(Consumer<CreateSecurityPolicyRequest.Builder> createSecurityPolicyRequest)
Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
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.default CompletableFuture<CreateVpcEndpointResponse> createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)
Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
createVpcEndpointRequest - default CompletableFuture<CreateVpcEndpointResponse> createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)
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.default CompletableFuture<DeleteAccessPolicyResponse> deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
deleteAccessPolicyRequest - default CompletableFuture<DeleteAccessPolicyResponse> deleteAccessPolicy(Consumer<DeleteAccessPolicyRequest.Builder> deleteAccessPolicyRequest)
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.default CompletableFuture<DeleteCollectionResponse> deleteCollection(DeleteCollectionRequest deleteCollectionRequest)
Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
deleteCollectionRequest - default CompletableFuture<DeleteCollectionResponse> deleteCollection(Consumer<DeleteCollectionRequest.Builder> deleteCollectionRequest)
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.default CompletableFuture<DeleteSecurityConfigResponse> deleteSecurityConfig(DeleteSecurityConfigRequest deleteSecurityConfigRequest)
Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
deleteSecurityConfigRequest - default CompletableFuture<DeleteSecurityConfigResponse> deleteSecurityConfig(Consumer<DeleteSecurityConfigRequest.Builder> deleteSecurityConfigRequest)
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.default CompletableFuture<DeleteSecurityPolicyResponse> deleteSecurityPolicy(DeleteSecurityPolicyRequest deleteSecurityPolicyRequest)
Deletes an OpenSearch Serverless security policy.
deleteSecurityPolicyRequest - default CompletableFuture<DeleteSecurityPolicyResponse> deleteSecurityPolicy(Consumer<DeleteSecurityPolicyRequest.Builder> deleteSecurityPolicyRequest)
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.default CompletableFuture<DeleteVpcEndpointResponse> deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)
Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
deleteVpcEndpointRequest - default CompletableFuture<DeleteVpcEndpointResponse> deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)
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.default CompletableFuture<GetAccessPolicyResponse> getAccessPolicy(GetAccessPolicyRequest getAccessPolicyRequest)
Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
getAccessPolicyRequest - default CompletableFuture<GetAccessPolicyResponse> getAccessPolicy(Consumer<GetAccessPolicyRequest.Builder> getAccessPolicyRequest)
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.default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Returns account-level settings related to OpenSearch Serverless.
getAccountSettingsRequest - default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)
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.default CompletableFuture<GetPoliciesStatsResponse> getPoliciesStats(GetPoliciesStatsRequest getPoliciesStatsRequest)
Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
getPoliciesStatsRequest - default CompletableFuture<GetPoliciesStatsResponse> getPoliciesStats(Consumer<GetPoliciesStatsRequest.Builder> getPoliciesStatsRequest)
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.default CompletableFuture<GetSecurityConfigResponse> getSecurityConfig(GetSecurityConfigRequest getSecurityConfigRequest)
Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.
getSecurityConfigRequest - default CompletableFuture<GetSecurityConfigResponse> getSecurityConfig(Consumer<GetSecurityConfigRequest.Builder> getSecurityConfigRequest)
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.default CompletableFuture<GetSecurityPolicyResponse> getSecurityPolicy(GetSecurityPolicyRequest getSecurityPolicyRequest)
Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
getSecurityPolicyRequest - default CompletableFuture<GetSecurityPolicyResponse> getSecurityPolicy(Consumer<GetSecurityPolicyRequest.Builder> getSecurityPolicyRequest)
Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
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.default CompletableFuture<ListAccessPoliciesResponse> listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
Returns information about a list of OpenSearch Serverless access policies.
listAccessPoliciesRequest - default CompletableFuture<ListAccessPoliciesResponse> listAccessPolicies(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)
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.default ListAccessPoliciesPublisher listAccessPoliciesPaginator(ListAccessPoliciesRequest listAccessPoliciesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListAccessPoliciesPublisher listAccessPoliciesPaginator(Consumer<ListAccessPoliciesRequest.Builder> listAccessPoliciesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opensearchserverless.paginators.ListAccessPoliciesPublisher publisher = client.listAccessPoliciesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListAccessPoliciesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListCollectionsResponse> listCollections(ListCollectionsRequest listCollectionsRequest)
Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Make sure to include an empty request body {} if you don't include any collection filters in the request.
listCollectionsRequest - default CompletableFuture<ListCollectionsResponse> listCollections(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)
Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Make sure to include an empty request body {} if you don't include any collection filters in the request.
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.default ListCollectionsPublisher listCollectionsPaginator(ListCollectionsRequest listCollectionsRequest)
Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Make sure to include an empty request body {} if you don't include any collection filters in the request.
This is a variant of
listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsPublisher publisher = client.listCollectionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsPublisher publisher = client.listCollectionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListCollectionsPublisher listCollectionsPaginator(Consumer<ListCollectionsRequest.Builder> listCollectionsRequest)
Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Make sure to include an empty request body {} if you don't include any collection filters in the request.
This is a variant of
listCollections(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsPublisher publisher = client.listCollectionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opensearchserverless.paginators.ListCollectionsPublisher publisher = client.listCollectionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListSecurityConfigsResponse> listSecurityConfigs(ListSecurityConfigsRequest listSecurityConfigsRequest)
Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
listSecurityConfigsRequest - default CompletableFuture<ListSecurityConfigsResponse> listSecurityConfigs(Consumer<ListSecurityConfigsRequest.Builder> listSecurityConfigsRequest)
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.default ListSecurityConfigsPublisher listSecurityConfigsPaginator(ListSecurityConfigsRequest listSecurityConfigsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsPublisher publisher = client.listSecurityConfigsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsPublisher publisher = client.listSecurityConfigsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListSecurityConfigsPublisher listSecurityConfigsPaginator(Consumer<ListSecurityConfigsRequest.Builder> listSecurityConfigsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsPublisher publisher = client.listSecurityConfigsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityConfigsPublisher publisher = client.listSecurityConfigsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityConfigsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListSecurityPoliciesResponse> listSecurityPolicies(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
Returns information about configured OpenSearch Serverless security policies.
listSecurityPoliciesRequest - default CompletableFuture<ListSecurityPoliciesResponse> listSecurityPolicies(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
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.default ListSecurityPoliciesPublisher listSecurityPoliciesPaginator(ListSecurityPoliciesRequest listSecurityPoliciesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListSecurityPoliciesPublisher listSecurityPoliciesPaginator(Consumer<ListSecurityPoliciesRequest.Builder> listSecurityPoliciesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opensearchserverless.paginators.ListSecurityPoliciesPublisher publisher = client.listSecurityPoliciesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListSecurityPoliciesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
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.default CompletableFuture<ListVpcEndpointsResponse> listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
listVpcEndpointsRequest - default CompletableFuture<ListVpcEndpointsResponse> listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
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.default ListVpcEndpointsPublisher listVpcEndpointsPaginator(ListVpcEndpointsRequest listVpcEndpointsRequest)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
This is a variant of
listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsPublisher publisher = client.listVpcEndpointsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsPublisher publisher = client.listVpcEndpointsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListVpcEndpointsPublisher listVpcEndpointsPaginator(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
This is a variant of
listVpcEndpoints(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsPublisher publisher = client.listVpcEndpointsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.opensearchserverless.paginators.ListVpcEndpointsPublisher publisher = client.listVpcEndpointsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.opensearchserverless.model.ListVpcEndpointsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
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.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
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.default CompletableFuture<UpdateAccessPolicyResponse> updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)
Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
updateAccessPolicyRequest - default CompletableFuture<UpdateAccessPolicyResponse> updateAccessPolicy(Consumer<UpdateAccessPolicyRequest.Builder> updateAccessPolicyRequest)
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.default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
updateAccountSettingsRequest - default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)
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.default CompletableFuture<UpdateCollectionResponse> updateCollection(UpdateCollectionRequest updateCollectionRequest)
Updates an OpenSearch Serverless collection.
updateCollectionRequest - default CompletableFuture<UpdateCollectionResponse> updateCollection(Consumer<UpdateCollectionRequest.Builder> updateCollectionRequest)
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.default CompletableFuture<UpdateSecurityConfigResponse> updateSecurityConfig(UpdateSecurityConfigRequest updateSecurityConfigRequest)
Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
updateSecurityConfigRequest - default CompletableFuture<UpdateSecurityConfigResponse> updateSecurityConfig(Consumer<UpdateSecurityConfigRequest.Builder> updateSecurityConfigRequest)
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.default CompletableFuture<UpdateSecurityPolicyResponse> updateSecurityPolicy(UpdateSecurityPolicyRequest updateSecurityPolicyRequest)
Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
updateSecurityPolicyRequest - default CompletableFuture<UpdateSecurityPolicyResponse> updateSecurityPolicy(Consumer<UpdateSecurityPolicyRequest.Builder> updateSecurityPolicyRequest)
Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
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.default CompletableFuture<UpdateVpcEndpointResponse> updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)
Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
updateVpcEndpointRequest - default CompletableFuture<UpdateVpcEndpointResponse> updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)
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.default OpenSearchServerlessServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic OpenSearchServerlessAsyncClient create()
OpenSearchServerlessAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static OpenSearchServerlessAsyncClientBuilder builder()
OpenSearchServerlessAsyncClient.Copyright © 2023. All rights reserved.