opensearchserverless/aws.sdk.kotlin.services.opensearchserverless

Package-level declarations

Types

interface OpenSearchServerlessClient : SdkClient

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

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

batchGetCollection

inline suspend fun OpenSearchServerlessClient.batchGetCollection(crossinline block: BatchGetCollectionRequest.Builder.() -> Unit): BatchGetCollectionResponse

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.

batchGetEffectiveLifecyclePolicy

inline suspend fun OpenSearchServerlessClient.batchGetEffectiveLifecyclePolicy(crossinline block: BatchGetEffectiveLifecyclePolicyRequest.Builder.() -> Unit): BatchGetEffectiveLifecyclePolicyResponse

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

batchGetLifecyclePolicy

inline suspend fun OpenSearchServerlessClient.batchGetLifecyclePolicy(crossinline block: BatchGetLifecyclePolicyRequest.Builder.() -> Unit): BatchGetLifecyclePolicyResponse

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

batchGetVpcEndpoint

inline suspend fun OpenSearchServerlessClient.batchGetVpcEndpoint(crossinline block: BatchGetVpcEndpointRequest.Builder.() -> Unit): BatchGetVpcEndpointResponse

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.

createAccessPolicy

inline suspend fun OpenSearchServerlessClient.createAccessPolicy(crossinline block: CreateAccessPolicyRequest.Builder.() -> Unit): CreateAccessPolicyResponse

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.

createCollection

inline suspend fun OpenSearchServerlessClient.createCollection(crossinline block: CreateCollectionRequest.Builder.() -> Unit): CreateCollectionResponse

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

createLifecyclePolicy

inline suspend fun OpenSearchServerlessClient.createLifecyclePolicy(crossinline block: CreateLifecyclePolicyRequest.Builder.() -> Unit): CreateLifecyclePolicyResponse

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.

createSecurityConfig

inline suspend fun OpenSearchServerlessClient.createSecurityConfig(crossinline block: CreateSecurityConfigRequest.Builder.() -> Unit): CreateSecurityConfigResponse

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

createSecurityPolicy

inline suspend fun OpenSearchServerlessClient.createSecurityPolicy(crossinline block: CreateSecurityPolicyRequest.Builder.() -> Unit): CreateSecurityPolicyResponse

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.

createVpcEndpoint

inline suspend fun OpenSearchServerlessClient.createVpcEndpoint(crossinline block: CreateVpcEndpointRequest.Builder.() -> Unit): CreateVpcEndpointResponse

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

deleteAccessPolicy

inline suspend fun OpenSearchServerlessClient.deleteAccessPolicy(crossinline block: DeleteAccessPolicyRequest.Builder.() -> Unit): DeleteAccessPolicyResponse

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

deleteCollection

inline suspend fun OpenSearchServerlessClient.deleteCollection(crossinline block: DeleteCollectionRequest.Builder.() -> Unit): DeleteCollectionResponse

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

deleteLifecyclePolicy

inline suspend fun OpenSearchServerlessClient.deleteLifecyclePolicy(crossinline block: DeleteLifecyclePolicyRequest.Builder.() -> Unit): DeleteLifecyclePolicyResponse

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

deleteSecurityConfig

inline suspend fun OpenSearchServerlessClient.deleteSecurityConfig(crossinline block: DeleteSecurityConfigRequest.Builder.() -> Unit): DeleteSecurityConfigResponse

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

deleteSecurityPolicy

inline suspend fun OpenSearchServerlessClient.deleteSecurityPolicy(crossinline block: DeleteSecurityPolicyRequest.Builder.() -> Unit): DeleteSecurityPolicyResponse

Deletes an OpenSearch Serverless security policy.

deleteVpcEndpoint

inline suspend fun OpenSearchServerlessClient.deleteVpcEndpoint(crossinline block: DeleteVpcEndpointRequest.Builder.() -> Unit): DeleteVpcEndpointResponse

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

getAccessPolicy

inline suspend fun OpenSearchServerlessClient.getAccessPolicy(crossinline block: GetAccessPolicyRequest.Builder.() -> Unit): GetAccessPolicyResponse

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

getAccountSettings

inline suspend fun OpenSearchServerlessClient.getAccountSettings(crossinline block: GetAccountSettingsRequest.Builder.() -> Unit): GetAccountSettingsResponse

Returns account-level settings related to OpenSearch Serverless.

getPoliciesStats

inline suspend fun OpenSearchServerlessClient.getPoliciesStats(crossinline block: GetPoliciesStatsRequest.Builder.() -> Unit): GetPoliciesStatsResponse

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

getSecurityConfig

inline suspend fun OpenSearchServerlessClient.getSecurityConfig(crossinline block: GetSecurityConfigRequest.Builder.() -> Unit): GetSecurityConfigResponse

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

getSecurityPolicy

inline suspend fun OpenSearchServerlessClient.getSecurityPolicy(crossinline block: GetSecurityPolicyRequest.Builder.() -> Unit): GetSecurityPolicyResponse

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.

listAccessPolicies

inline suspend fun OpenSearchServerlessClient.listAccessPolicies(crossinline block: ListAccessPoliciesRequest.Builder.() -> Unit): ListAccessPoliciesResponse

Returns information about a list of OpenSearch Serverless access policies.

listCollections

inline suspend fun OpenSearchServerlessClient.listCollections(crossinline block: ListCollectionsRequest.Builder.() -> Unit): ListCollectionsResponse

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

listLifecyclePolicies

inline suspend fun OpenSearchServerlessClient.listLifecyclePolicies(crossinline block: ListLifecyclePoliciesRequest.Builder.() -> Unit): ListLifecyclePoliciesResponse

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

listSecurityConfigs

inline suspend fun OpenSearchServerlessClient.listSecurityConfigs(crossinline block: ListSecurityConfigsRequest.Builder.() -> Unit): ListSecurityConfigsResponse

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

listSecurityPolicies

inline suspend fun OpenSearchServerlessClient.listSecurityPolicies(crossinline block: ListSecurityPoliciesRequest.Builder.() -> Unit): ListSecurityPoliciesResponse

Returns information about configured OpenSearch Serverless security policies.

listTagsForResource

inline suspend fun OpenSearchServerlessClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

listVpcEndpoints

inline suspend fun OpenSearchServerlessClient.listVpcEndpoints(crossinline block: ListVpcEndpointsRequest.Builder.() -> Unit): ListVpcEndpointsResponse

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.

tagResource

inline suspend fun OpenSearchServerlessClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun OpenSearchServerlessClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

updateAccessPolicy

inline suspend fun OpenSearchServerlessClient.updateAccessPolicy(crossinline block: UpdateAccessPolicyRequest.Builder.() -> Unit): UpdateAccessPolicyResponse

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

updateAccountSettings

inline suspend fun OpenSearchServerlessClient.updateAccountSettings(crossinline block: UpdateAccountSettingsRequest.Builder.() -> Unit): UpdateAccountSettingsResponse

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

updateCollection

inline suspend fun OpenSearchServerlessClient.updateCollection(crossinline block: UpdateCollectionRequest.Builder.() -> Unit): UpdateCollectionResponse

Updates an OpenSearch Serverless collection.

updateLifecyclePolicy

inline suspend fun OpenSearchServerlessClient.updateLifecyclePolicy(crossinline block: UpdateLifecyclePolicyRequest.Builder.() -> Unit): UpdateLifecyclePolicyResponse

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

updateSecurityConfig

inline suspend fun OpenSearchServerlessClient.updateSecurityConfig(crossinline block: UpdateSecurityConfigRequest.Builder.() -> Unit): UpdateSecurityConfigResponse

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

updateSecurityPolicy

inline suspend fun OpenSearchServerlessClient.updateSecurityPolicy(crossinline block: UpdateSecurityPolicyRequest.Builder.() -> Unit): UpdateSecurityPolicyResponse

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

updateVpcEndpoint

inline suspend fun OpenSearchServerlessClient.updateVpcEndpoint(crossinline block: UpdateVpcEndpointRequest.Builder.() -> Unit): UpdateVpcEndpointResponse

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

withConfig

fun OpenSearchServerlessClient.withConfig(block: OpenSearchServerlessClient.Config.Builder.() -> Unit): OpenSearchServerlessClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.