@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSOpenSearchServerless extends Object implements AWSOpenSearchServerless
AWSOpenSearchServerless
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchGetCollectionResult |
batchGetCollection(BatchGetCollectionRequest request)
Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards
endpoint.
|
BatchGetEffectiveLifecyclePolicyResult |
batchGetEffectiveLifecyclePolicy(BatchGetEffectiveLifecyclePolicyRequest request)
Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes.
|
BatchGetLifecyclePolicyResult |
batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest request)
Returns one or more configured OpenSearch Serverless lifecycle policies.
|
BatchGetVpcEndpointResult |
batchGetVpcEndpoint(BatchGetVpcEndpointRequest request)
Returns attributes for one or more VPC endpoints associated with the current account.
|
CreateAccessPolicyResult |
createAccessPolicy(CreateAccessPolicyRequest request)
Creates a data access policy for OpenSearch Serverless.
|
CreateCollectionResult |
createCollection(CreateCollectionRequest request)
Creates a new OpenSearch Serverless collection.
|
CreateLifecyclePolicyResult |
createLifecyclePolicy(CreateLifecyclePolicyRequest request)
Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.
|
CreateSecurityConfigResult |
createSecurityConfig(CreateSecurityConfigRequest request)
Specifies a security configuration for OpenSearch Serverless.
|
CreateSecurityPolicyResult |
createSecurityPolicy(CreateSecurityPolicyRequest request)
Creates a security policy to be used by one or more OpenSearch Serverless collections.
|
CreateVpcEndpointResult |
createVpcEndpoint(CreateVpcEndpointRequest request)
Creates an OpenSearch Serverless-managed interface VPC endpoint.
|
DeleteAccessPolicyResult |
deleteAccessPolicy(DeleteAccessPolicyRequest request)
Deletes an OpenSearch Serverless access policy.
|
DeleteCollectionResult |
deleteCollection(DeleteCollectionRequest request)
Deletes an OpenSearch Serverless collection.
|
DeleteLifecyclePolicyResult |
deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request)
Deletes an OpenSearch Serverless lifecycle policy.
|
DeleteSecurityConfigResult |
deleteSecurityConfig(DeleteSecurityConfigRequest request)
Deletes a security configuration for OpenSearch Serverless.
|
DeleteSecurityPolicyResult |
deleteSecurityPolicy(DeleteSecurityPolicyRequest request)
Deletes an OpenSearch Serverless security policy.
|
DeleteVpcEndpointResult |
deleteVpcEndpoint(DeleteVpcEndpointRequest request)
Deletes an OpenSearch Serverless-managed interface endpoint.
|
GetAccessPolicyResult |
getAccessPolicy(GetAccessPolicyRequest request)
Returns an OpenSearch Serverless access policy.
|
GetAccountSettingsResult |
getAccountSettings(GetAccountSettingsRequest request)
Returns account-level settings related to OpenSearch Serverless.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetPoliciesStatsResult |
getPoliciesStats(GetPoliciesStatsRequest request)
Returns statistical information about your OpenSearch Serverless access policies, security configurations, and
security policies.
|
GetSecurityConfigResult |
getSecurityConfig(GetSecurityConfigRequest request)
Returns information about an OpenSearch Serverless security configuration.
|
GetSecurityPolicyResult |
getSecurityPolicy(GetSecurityPolicyRequest request)
Returns information about a configured OpenSearch Serverless security policy.
|
ListAccessPoliciesResult |
listAccessPolicies(ListAccessPoliciesRequest request)
Returns information about a list of OpenSearch Serverless access policies.
|
ListCollectionsResult |
listCollections(ListCollectionsRequest request)
Lists all OpenSearch Serverless collections.
|
ListLifecyclePoliciesResult |
listLifecyclePolicies(ListLifecyclePoliciesRequest request)
Returns a list of OpenSearch Serverless lifecycle policies.
|
ListSecurityConfigsResult |
listSecurityConfigs(ListSecurityConfigsRequest request)
Returns information about configured OpenSearch Serverless security configurations.
|
ListSecurityPoliciesResult |
listSecurityPolicies(ListSecurityPoliciesRequest request)
Returns information about configured OpenSearch Serverless security policies.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns the tags for an OpenSearch Serverless resource.
|
ListVpcEndpointsResult |
listVpcEndpoints(ListVpcEndpointsRequest request)
Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associates tags with an OpenSearch Serverless resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag or set of tags from an OpenSearch Serverless resource.
|
UpdateAccessPolicyResult |
updateAccessPolicy(UpdateAccessPolicyRequest request)
Updates an OpenSearch Serverless access policy.
|
UpdateAccountSettingsResult |
updateAccountSettings(UpdateAccountSettingsRequest request)
Update the OpenSearch Serverless settings for the current Amazon Web Services account.
|
UpdateCollectionResult |
updateCollection(UpdateCollectionRequest request)
Updates an OpenSearch Serverless collection.
|
UpdateLifecyclePolicyResult |
updateLifecyclePolicy(UpdateLifecyclePolicyRequest request)
Updates an OpenSearch Serverless access policy.
|
UpdateSecurityConfigResult |
updateSecurityConfig(UpdateSecurityConfigRequest request)
Updates a security configuration for OpenSearch Serverless.
|
UpdateSecurityPolicyResult |
updateSecurityPolicy(UpdateSecurityPolicyRequest request)
Updates an OpenSearch Serverless security policy.
|
UpdateVpcEndpointResult |
updateVpcEndpoint(UpdateVpcEndpointRequest request)
Updates an OpenSearch Serverless-managed interface endpoint.
|
public BatchGetCollectionResult batchGetCollection(BatchGetCollectionRequest request)
AWSOpenSearchServerless
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.
batchGetCollection
in interface AWSOpenSearchServerless
public BatchGetEffectiveLifecyclePolicyResult batchGetEffectiveLifecyclePolicy(BatchGetEffectiveLifecyclePolicyRequest request)
AWSOpenSearchServerless
Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.
batchGetEffectiveLifecyclePolicy
in interface AWSOpenSearchServerless
public BatchGetLifecyclePolicyResult batchGetLifecyclePolicy(BatchGetLifecyclePolicyRequest request)
AWSOpenSearchServerless
Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
batchGetLifecyclePolicy
in interface AWSOpenSearchServerless
public BatchGetVpcEndpointResult batchGetVpcEndpoint(BatchGetVpcEndpointRequest request)
AWSOpenSearchServerless
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.
batchGetVpcEndpoint
in interface AWSOpenSearchServerless
public CreateAccessPolicyResult createAccessPolicy(CreateAccessPolicyRequest request)
AWSOpenSearchServerless
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.
createAccessPolicy
in interface AWSOpenSearchServerless
public CreateCollectionResult createCollection(CreateCollectionRequest request)
AWSOpenSearchServerless
Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
createCollection
in interface AWSOpenSearchServerless
public CreateLifecyclePolicyResult createLifecyclePolicy(CreateLifecyclePolicyRequest request)
AWSOpenSearchServerless
Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.
createLifecyclePolicy
in interface AWSOpenSearchServerless
public CreateSecurityConfigResult createSecurityConfig(CreateSecurityConfigRequest request)
AWSOpenSearchServerless
Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
createSecurityConfig
in interface AWSOpenSearchServerless
public CreateSecurityPolicyResult createSecurityPolicy(CreateSecurityPolicyRequest request)
AWSOpenSearchServerless
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.
createSecurityPolicy
in interface AWSOpenSearchServerless
public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)
AWSOpenSearchServerless
Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
createVpcEndpoint
in interface AWSOpenSearchServerless
public DeleteAccessPolicyResult deleteAccessPolicy(DeleteAccessPolicyRequest request)
AWSOpenSearchServerless
Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
deleteAccessPolicy
in interface AWSOpenSearchServerless
public DeleteCollectionResult deleteCollection(DeleteCollectionRequest request)
AWSOpenSearchServerless
Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
deleteCollection
in interface AWSOpenSearchServerless
public DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request)
AWSOpenSearchServerless
Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.
deleteLifecyclePolicy
in interface AWSOpenSearchServerless
public DeleteSecurityConfigResult deleteSecurityConfig(DeleteSecurityConfigRequest request)
AWSOpenSearchServerless
Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
deleteSecurityConfig
in interface AWSOpenSearchServerless
public DeleteSecurityPolicyResult deleteSecurityPolicy(DeleteSecurityPolicyRequest request)
AWSOpenSearchServerless
Deletes an OpenSearch Serverless security policy.
deleteSecurityPolicy
in interface AWSOpenSearchServerless
public DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest request)
AWSOpenSearchServerless
Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
deleteVpcEndpoint
in interface AWSOpenSearchServerless
public GetAccessPolicyResult getAccessPolicy(GetAccessPolicyRequest request)
AWSOpenSearchServerless
Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
getAccessPolicy
in interface AWSOpenSearchServerless
public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
AWSOpenSearchServerless
Returns account-level settings related to OpenSearch Serverless.
getAccountSettings
in interface AWSOpenSearchServerless
public GetPoliciesStatsResult getPoliciesStats(GetPoliciesStatsRequest request)
AWSOpenSearchServerless
Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
getPoliciesStats
in interface AWSOpenSearchServerless
public GetSecurityConfigResult getSecurityConfig(GetSecurityConfigRequest request)
AWSOpenSearchServerless
Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.
getSecurityConfig
in interface AWSOpenSearchServerless
public GetSecurityPolicyResult getSecurityPolicy(GetSecurityPolicyRequest request)
AWSOpenSearchServerless
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.
getSecurityPolicy
in interface AWSOpenSearchServerless
public ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest request)
AWSOpenSearchServerless
Returns information about a list of OpenSearch Serverless access policies.
listAccessPolicies
in interface AWSOpenSearchServerless
public ListCollectionsResult listCollections(ListCollectionsRequest request)
AWSOpenSearchServerless
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.
listCollections
in interface AWSOpenSearchServerless
public ListLifecyclePoliciesResult listLifecyclePolicies(ListLifecyclePoliciesRequest request)
AWSOpenSearchServerless
Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
listLifecyclePolicies
in interface AWSOpenSearchServerless
public ListSecurityConfigsResult listSecurityConfigs(ListSecurityConfigsRequest request)
AWSOpenSearchServerless
Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
listSecurityConfigs
in interface AWSOpenSearchServerless
public ListSecurityPoliciesResult listSecurityPolicies(ListSecurityPoliciesRequest request)
AWSOpenSearchServerless
Returns information about configured OpenSearch Serverless security policies.
listSecurityPolicies
in interface AWSOpenSearchServerless
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSOpenSearchServerless
Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
listTagsForResource
in interface AWSOpenSearchServerless
public ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest request)
AWSOpenSearchServerless
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.
listVpcEndpoints
in interface AWSOpenSearchServerless
public TagResourceResult tagResource(TagResourceRequest request)
AWSOpenSearchServerless
Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
tagResource
in interface AWSOpenSearchServerless
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSOpenSearchServerless
Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
untagResource
in interface AWSOpenSearchServerless
public UpdateAccessPolicyResult updateAccessPolicy(UpdateAccessPolicyRequest request)
AWSOpenSearchServerless
Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.
updateAccessPolicy
in interface AWSOpenSearchServerless
public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
AWSOpenSearchServerless
Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.
updateAccountSettings
in interface AWSOpenSearchServerless
public UpdateCollectionResult updateCollection(UpdateCollectionRequest request)
AWSOpenSearchServerless
Updates an OpenSearch Serverless collection.
updateCollection
in interface AWSOpenSearchServerless
public UpdateLifecyclePolicyResult updateLifecyclePolicy(UpdateLifecyclePolicyRequest request)
AWSOpenSearchServerless
Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.
updateLifecyclePolicy
in interface AWSOpenSearchServerless
public UpdateSecurityConfigResult updateSecurityConfig(UpdateSecurityConfigRequest request)
AWSOpenSearchServerless
Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
updateSecurityConfig
in interface AWSOpenSearchServerless
public UpdateSecurityPolicyResult updateSecurityPolicy(UpdateSecurityPolicyRequest request)
AWSOpenSearchServerless
Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.
updateSecurityPolicy
in interface AWSOpenSearchServerless
public UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest request)
AWSOpenSearchServerless
Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.
updateVpcEndpoint
in interface AWSOpenSearchServerless
public void shutdown()
AWSOpenSearchServerless
shutdown
in interface AWSOpenSearchServerless
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSOpenSearchServerless
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSOpenSearchServerless
request
- The originally executed request.