Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1446252177.2 KB

Creates a new OpenSearch Serverless collection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and managing Amazon OpenSearch Serverless collections</a>.

post/#X-Amz-Target=OpenSearchServerless.CreateCollection

Headers

X-Amz-Target'OpenSearchServerless.CreateCollection' required

Request body

namestring required

Name of the collection.

type'SEARCH' | 'TIMESERIES' | 'VECTORSEARCH'

The type of collection.

descriptionstring

Description of the collection.

standbyReplicas'ENABLED' | 'DISABLED'

Indicates whether standby replicas should be used for a collection.

collectionGroupNamestring

The name of the collection group to associate with the collection.

deletionProtection'ENABLED' | 'DISABLED'

Indicates whether to enable deletion protection for the collection. When set to <code>ENABLED</code>, the collection cannot be deleted.

clientTokenstring

Unique, case-sensitive identifier to ensure idempotency of the request.

Response

Success