Amazon Web Services, Inc.

OpenSearch Service Serverless

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

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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?

Endpoints 54

Ingestion job

  • POSTCancel ingestion job/#X-Amz-Target=OpenSearchServerless.CancelIngestionJobCancels an in-progress ingestion job. Documents that were already indexed before the cancellation remain in the index.
  • POSTCreate ingestion job/#X-Amz-Target=OpenSearchServerless.CreateIngestionJobCreates an ingestion job that performs a one-time bulk ingestion of data from an Amazon S3 bucket into an index in an OpenSearch Serverless collection. An…
  • POSTGet ingestion job/#X-Amz-Target=OpenSearchServerless.GetIngestionJobReturns information about an ingestion job, including its configuration, status, and processing state.
  • POSTList ingestion jobs/#X-Amz-Target=OpenSearchServerless.ListIngestionJobsReturns a list of ingestion jobs in a collection.

Access policy

  • POSTCreate access policy/#X-Amz-Target=OpenSearchServerless.CreateAccessPolicyCreates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access…
  • POSTDelete access policy/#X-Amz-Target=OpenSearchServerless.DeleteAccessPolicyDeletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless .
  • POSTGet access policy/#X-Amz-Target=OpenSearchServerless.GetAccessPolicyReturns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless .
  • POSTList access policies/#X-Amz-Target=OpenSearchServerless.ListAccessPoliciesReturns information about a list of OpenSearch Serverless access policies.
  • POSTUpdate access policy/#X-Amz-Target=OpenSearchServerless.UpdateAccessPolicyUpdates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless .

Collection

  • POSTCreate collection/#X-Amz-Target=OpenSearchServerless.CreateCollectionCreates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections .
  • POSTDelete collection/#X-Amz-Target=OpenSearchServerless.DeleteCollectionDeletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections .
  • POSTList collections/#X-Amz-Target=OpenSearchServerless.ListCollectionsLists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections . Make sure to include…
  • POSTUpdate collection/#X-Amz-Target=OpenSearchServerless.UpdateCollectionUpdates an OpenSearch Serverless collection.

Collection group

  • POSTCreate collection group/#X-Amz-Target=OpenSearchServerless.CreateCollectionGroupCreates a collection group within OpenSearch Serverless. Collection groups let you manage OpenSearch Compute Units (OCUs) at a group level, with multiple…
  • POSTDelete collection group/#X-Amz-Target=OpenSearchServerless.DeleteCollectionGroupDeletes a collection group. You can only delete empty collection groups that contain no collections. For more information, see Creating and managing Amazon…
  • POSTList collection groups/#X-Amz-Target=OpenSearchServerless.ListCollectionGroupsReturns a list of collection groups. For more information, see Creating and managing Amazon OpenSearch Serverless collections .
  • POSTUpdate collection group/#X-Amz-Target=OpenSearchServerless.UpdateCollectionGroupUpdates the description and capacity limits of a collection group.

Index

  • POSTCreate index/#X-Amz-Target=OpenSearchServerless.CreateIndexCreates an index within an OpenSearch Serverless collection. Unlike other OpenSearch indexes, indexes created by this API are automatically configured to…
  • POSTDelete index/#X-Amz-Target=OpenSearchServerless.DeleteIndexDeletes an index from an OpenSearch Serverless collection. Be aware that the index might be configured to conduct automatic semantic enrichment ingestion and…
  • POSTGet index/#X-Amz-Target=OpenSearchServerless.GetIndexRetrieves information about an index in an OpenSearch Serverless collection, including its schema definition. The index might be configured to conduct…
  • POSTUpdate index/#X-Amz-Target=OpenSearchServerless.UpdateIndexUpdates an existing index in an OpenSearch Serverless collection. This operation allows you to modify the index schema, including adding new fields or…

Ingestion stream

  • POSTCreate ingestion stream/#X-Amz-Target=OpenSearchServerless.CreateIngestionStreamCreates an ingestion stream that continuously ingests data from an Amazon S3 bucket into an index in an OpenSearch Serverless collection. An ingestion stream…
  • POSTDelete ingestion stream/#X-Amz-Target=OpenSearchServerless.DeleteIngestionStreamDeletes an ingestion stream. Documents that were already indexed by the stream remain in the index.
  • POSTGet ingestion stream/#X-Amz-Target=OpenSearchServerless.GetIngestionStreamReturns information about an ingestion stream, including its configuration, status, and processing state.
  • POSTList ingestion streams/#X-Amz-Target=OpenSearchServerless.ListIngestionStreamsReturns a list of ingestion streams in a collection.

Security config

  • POSTCreate security config/#X-Amz-Target=OpenSearchServerless.CreateSecurityConfigSpecifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless .
  • POSTDelete security config/#X-Amz-Target=OpenSearchServerless.DeleteSecurityConfigDeletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless .
  • POSTGet security config/#X-Amz-Target=OpenSearchServerless.GetSecurityConfigReturns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless .
  • POSTList security configs/#X-Amz-Target=OpenSearchServerless.ListSecurityConfigsReturns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch…
  • POSTUpdate security config/#X-Amz-Target=OpenSearchServerless.UpdateSecurityConfigUpdates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless .

Vpc endpoint

  • POSTCreate vpc endpoint/#X-Amz-Target=OpenSearchServerless.CreateVpcEndpointCreates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint .
  • POSTDelete vpc endpoint/#X-Amz-Target=OpenSearchServerless.DeleteVpcEndpointDeletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint .
  • POSTList vpc endpoints/#X-Amz-Target=OpenSearchServerless.ListVpcEndpointsReturns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch…

Lifecycle policy

  • POSTDelete lifecycle policy/#X-Amz-Target=OpenSearchServerless.DeleteLifecyclePolicyDeletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies .
  • POSTList lifecycle policies/#X-Amz-Target=OpenSearchServerless.ListLifecyclePoliciesReturns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies .
  • POSTUpdate lifecycle policy/#X-Amz-Target=OpenSearchServerless.UpdateLifecyclePolicyUpdates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies .

Security policy

  • POSTDelete security policy/#X-Amz-Target=OpenSearchServerless.DeleteSecurityPolicyDeletes an OpenSearch Serverless security policy.
  • POSTGet security policy/#X-Amz-Target=OpenSearchServerless.GetSecurityPolicyReturns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and…
  • POSTList security policies/#X-Amz-Target=OpenSearchServerless.ListSecurityPoliciesReturns information about configured OpenSearch Serverless security policies.
  • POSTUpdate security policy/#X-Amz-Target=OpenSearchServerless.UpdateSecurityPolicyUpdates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon…
  • POSTBatch get collection/#X-Amz-Target=OpenSearchServerless.BatchGetCollectionReturns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints. For more…
  • POSTBatch get collection group/#X-Amz-Target=OpenSearchServerless.BatchGetCollectionGroupReturns attributes for one or more collection groups, including capacity limits and the number of collections in each group. For more information, see…
  • POSTBatch get effective lifecycle policy/#X-Amz-Target=OpenSearchServerless.BatchGetEffectiveLifecyclePolicyReturns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies .
  • POSTBatch get lifecycle policy/#X-Amz-Target=OpenSearchServerless.BatchGetLifecyclePolicyReturns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies .
  • POSTBatch get vpc endpoint/#X-Amz-Target=OpenSearchServerless.BatchGetVpcEndpointReturns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an…
  • POSTCreate lifecycle policy/#X-Amz-Target=OpenSearchServerless.CreateLifecyclePolicyCreates 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…
  • POSTCreate security policy/#X-Amz-Target=OpenSearchServerless.CreateSecurityPolicyCreates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch…
  • POSTGet account settings/#X-Amz-Target=OpenSearchServerless.GetAccountSettingsReturns account-level settings related to OpenSearch Serverless.
  • POSTGet policies stats/#X-Amz-Target=OpenSearchServerless.GetPoliciesStatsReturns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.
  • POSTList tags for resource/#X-Amz-Target=OpenSearchServerless.ListTagsForResourceReturns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections .
  • POSTTag resource/#X-Amz-Target=OpenSearchServerless.TagResourceAssociates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections .
  • POSTUntag resource/#X-Amz-Target=OpenSearchServerless.UntagResourceRemoves a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections .
  • POSTUpdate account settings/#X-Amz-Target=OpenSearchServerless.UpdateAccountSettingsUpdate the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon…
  • POSTUpdate vpc endpoint/#X-Amz-Target=OpenSearchServerless.UpdateVpcEndpointUpdates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint .

API details

Base URL
https://aoss.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
54 operations on 54 pathsPOST 54
Main resources
Access policy 5Security config 5Collection 4Collection group 4Index 4Ingestion job 4Ingestion stream 4Security policy 4Lifecycle policy 3Vpc endpoint 3
Description format
AWS Smithy model, API version 2021-11-01

How to test the OpenSearch Service Serverless in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the OpenSearch Service Serverless collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Cancel ingestion job” (POST /#X-Amz-Target=OpenSearchServerless.CancelIngestionJob), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the OpenSearch Service Serverless?

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies. OpenSearch Serverless is an… It is listed under Developer tools and has 54 endpoints.

Who publishes the OpenSearch Service Serverless?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the OpenSearch Service Serverless?

Requests go to https://aoss.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the OpenSearch Service Serverless?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the OpenSearch Service Serverless have?

54 operations on 54 paths (54 POST). The largest groups are Access policy, Security config, Collection, Collection group.

Is forking the OpenSearch Service Serverless free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.