OpenSearchServiceServerless / Client / create_collection_group

create_collection_group¶

OpenSearchServiceServerless.Client.create_collection_group(**kwargs)¶

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.

Request Syntax

response = client.create_collection_group(
    name='string',
    standbyReplicas='ENABLED'|'DISABLED',
    description='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    capacityLimits={
        'maxIndexingCapacityInOCU': ...,
        'maxSearchCapacityInOCU': ...,
        'minIndexingCapacityInOCU': ...,
        'minSearchCapacityInOCU': ...
    },
    clientToken='string'
)

Parameters:

name (string) –
[REQUIRED]

The name of the collection group.
standbyReplicas (string) –
[REQUIRED]

Indicates whether standby replicas should be used for a collection group.
description (string) – A description of the collection group.
tags (list) –
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.
- (dict) –
  
  A map of key-value pairs associated to an OpenSearch Serverless resource.
  - key (string) – [REQUIRED]
    
    The key to use in the tag.
  - value (string) – [REQUIRED]
    
    The value of the tag.
capacityLimits (dict) –
The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). These limits control the maximum and minimum capacity for collections within the group.
- maxIndexingCapacityInOCU (float) –
  
  The maximum indexing capacity for collections in the group.
- maxSearchCapacityInOCU (float) –
  
  The maximum search capacity for collections in the group.
- minIndexingCapacityInOCU (float) –
  
  The minimum indexing capacity for collections in the group.
- minSearchCapacityInOCU (float) –
  
  The minimum search capacity for collections in the group.
clientToken (string) –
Unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'createCollectionGroupDetail': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'standbyReplicas': 'ENABLED'|'DISABLED',
        'description': 'string',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'createdDate': 123,
        'capacityLimits': {
            'maxIndexingCapacityInOCU': ...,
            'maxSearchCapacityInOCU': ...,
            'minIndexingCapacityInOCU': ...,
            'minSearchCapacityInOCU': ...
        }
    }
}

Response Structure

(dict) –
- createCollectionGroupDetail (dict) –
  
  Details about the created collection group.
  - id (string) –
    
    The unique identifier of the collection group.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the collection group.
  - name (string) –
    
    The name of the collection group.
  - standbyReplicas (string) –
    
    Indicates whether standby replicas are used for the collection group.
  - description (string) –
    
    The description of the collection group.
  - tags (list) –
    
    A map of key-value pairs associated with the collection group.
    - (dict) –
      
      A map of key-value pairs associated to an OpenSearch Serverless resource.
      - key (string) –
        
        The key to use in the tag.
      - value (string) –
        
        The value of the tag.
  - createdDate (integer) –
    
    The Epoch time when the collection group was created.
  - capacityLimits (dict) –
    
    The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
    - maxIndexingCapacityInOCU (float) –
      
      The maximum indexing capacity for collections in the group.
    - maxSearchCapacityInOCU (float) –
      
      The maximum search capacity for collections in the group.
    - minIndexingCapacityInOCU (float) –
      
      The minimum indexing capacity for collections in the group.
    - minSearchCapacityInOCU (float) –
      
      The minimum search capacity for collections in the group.

Exceptions

OpenSearchServiceServerless.Client.exceptions.InternalServerException
OpenSearchServiceServerless.Client.exceptions.ConflictException
OpenSearchServiceServerless.Client.exceptions.ValidationException
OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExceededException