Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1446252177.2 KB

Creates a collection group within OpenSearch Serverless. Collection groups let you manage OpenSearch Compute Units (OCUs) at a group level, with multiple collections sharing the group's capacity limits.

For more information, see Managing collection groups.

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

Headers

X-Amz-Target'OpenSearchServerless.CreateCollectionGroup' required

Request body

namestring required

The name of the collection group.

standbyReplicas'ENABLED' | 'DISABLED' required

Indicates whether standby replicas should be used for a collection group.

descriptionstring

A description of the collection group.

generation'CLASSIC' | 'NEXTGEN'

The generation of Amazon OpenSearch Serverless for the collection group. Valid values are <code>CLASSIC</code> and <code>NEXTGEN</code>.

clientTokenstring

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

Response

Success