View Source AWS.OpenSearchServerless (aws-elixir v1.0.4)

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?

Link to this section Summary

Functions

batch_get_collection(client, input, options \\ [])

Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint.

batch_get_effective_lifecycle_policy(client, input, options \\ [])

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes.

batch_get_lifecycle_policy(client, input, options \\ [])

Returns one or more configured OpenSearch Serverless lifecycle policies.

batch_get_vpc_endpoint(client, input, options \\ [])

Returns attributes for one or more VPC endpoints associated with the current account.

create_access_policy(client, input, options \\ [])

Creates a data access policy for OpenSearch Serverless.

create_collection(client, input, options \\ [])

Creates a new OpenSearch Serverless collection.

create_lifecycle_policy(client, input, options \\ [])

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.

create_security_config(client, input, options \\ [])

Specifies a security configuration for OpenSearch Serverless.

create_security_policy(client, input, options \\ [])

Creates a security policy to be used by one or more OpenSearch Serverless collections.

create_vpc_endpoint(client, input, options \\ [])

Creates an OpenSearch Serverless-managed interface VPC endpoint.

delete_access_policy(client, input, options \\ [])

Deletes an OpenSearch Serverless access policy.

delete_collection(client, input, options \\ [])

Deletes an OpenSearch Serverless collection.

delete_lifecycle_policy(client, input, options \\ [])

Deletes an OpenSearch Serverless lifecycle policy.

delete_security_config(client, input, options \\ [])

Deletes a security configuration for OpenSearch Serverless.

delete_security_policy(client, input, options \\ [])

Deletes an OpenSearch Serverless security policy.

delete_vpc_endpoint(client, input, options \\ [])

Deletes an OpenSearch Serverless-managed interface endpoint.

get_access_policy(client, input, options \\ [])

Returns an OpenSearch Serverless access policy.

get_account_settings(client, input, options \\ [])

Returns account-level settings related to OpenSearch Serverless.

get_policies_stats(client, input, options \\ [])

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

get_security_config(client, input, options \\ [])

Returns information about an OpenSearch Serverless security configuration.

get_security_policy(client, input, options \\ [])

Returns information about a configured OpenSearch Serverless security policy.

list_access_policies(client, input, options \\ [])

Returns information about a list of OpenSearch Serverless access policies.

list_collections(client, input, options \\ [])

Lists all OpenSearch Serverless collections.

list_lifecycle_policies(client, input, options \\ [])

Returns a list of OpenSearch Serverless lifecycle policies.

list_security_configs(client, input, options \\ [])

Returns information about configured OpenSearch Serverless security configurations.

list_security_policies(client, input, options \\ [])

Returns information about configured OpenSearch Serverless security policies.

list_tags_for_resource(client, input, options \\ [])

Returns the tags for an OpenSearch Serverless resource.

list_vpc_endpoints(client, input, options \\ [])

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account.

metadata()

tag_resource(client, input, options \\ [])

Associates tags with an OpenSearch Serverless resource.

untag_resource(client, input, options \\ [])

Removes a tag or set of tags from an OpenSearch Serverless resource.

update_access_policy(client, input, options \\ [])

Updates an OpenSearch Serverless access policy.

update_account_settings(client, input, options \\ [])

Update the OpenSearch Serverless settings for the current Amazon Web Services account.

update_collection(client, input, options \\ [])

Updates an OpenSearch Serverless collection.

update_lifecycle_policy(client, input, options \\ [])

Updates an OpenSearch Serverless access policy.

update_security_config(client, input, options \\ [])

Updates a security configuration for OpenSearch Serverless.

update_security_policy(client, input, options \\ [])

Updates an OpenSearch Serverless security policy.

update_vpc_endpoint(client, input, options \\ [])

Updates an OpenSearch Serverless-managed interface endpoint.

Link to this section Functions

batch_get_collection(client, input, options \\ [])

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.

batch_get_effective_lifecycle_policy(client, input, options \\ [])

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes.

For more information, see Viewing data lifecycle policies.

batch_get_lifecycle_policy(client, input, options \\ [])

Returns one or more configured OpenSearch Serverless lifecycle policies.

For more information, see Viewing data lifecycle policies.

batch_get_vpc_endpoint(client, input, options \\ [])

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.

create_access_policy(client, input, options \\ [])

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.

create_collection(client, input, options \\ [])

Creates a new OpenSearch Serverless collection.

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

create_lifecycle_policy(client, input, options \\ [])

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.

create_security_config(client, input, options \\ [])

Specifies a security configuration for OpenSearch Serverless.

For more information, see SAML authentication for Amazon OpenSearch Serverless.

create_security_policy(client, input, options \\ [])

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.