AWS API Changes

2026/01/15 - OpenSearch Service Serverless - 5 new3 updated api methods

Changes Collection groups in Amazon OpenSearch Serverless enables to organize multiple collections and enable compute resource sharing across collections with different KMS keys. This shared compute model reduces costs by eliminating the need for separate OpenSearch Compute Units (OCUs) for each KMS key.

ListCollectionGroups (new)

Link ¶

Returns a list of collection groups. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

See also: AWS API Documentation

Request Syntax

client.list_collection_groups(
    nextToken='string',
    maxResults=123
)

type nextToken:

string

param nextToken:

If your initial ListCollectionGroups operation returns a nextToken, you can include the returned nextToken in subsequent ListCollectionGroups operations, which returns results in the next page.

type maxResults:

integer

param maxResults:

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'collectionGroupSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'numberOfCollections': 123,
            'createdDate': 123,
            'capacityLimits': {
                'maxIndexingCapacityInOCU': ...,
                'maxSearchCapacityInOCU': ...,
                'minIndexingCapacityInOCU': ...,
                'minSearchCapacityInOCU': ...
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- collectionGroupSummaries (list) --
  
  Details about each collection group.
  - (dict) --
    
    Summary information about a 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.
    - numberOfCollections (integer) --
      
      The number of collections within the collection group.
    - createdDate (integer) --
      
      The Epoch time when the collection group was created.
    - capacityLimits (dict) --
      
      Capacity limits for a collection group. These limits define the minimum and maximum OpenSearch Compute Units (OCUs) for indexing and search operations that can be used by collections in 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.
- nextToken (string) --
  
  When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

CreateCollectionGroup (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

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

type name:

string

param name:

[REQUIRED]

The name of the collection group.

type standbyReplicas:

string

param standbyReplicas:

[REQUIRED]

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

type description:

string

param description:

A description of the collection group.

type tags:

list

param tags:

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.

type capacityLimits:

dict

param capacityLimits:

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.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

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.

BatchGetCollectionGroup (new)

Link ¶

Returns attributes for one or more collection groups, including capacity limits and the number of collections in each group. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

See also: AWS API Documentation

Request Syntax

client.batch_get_collection_group(
    ids=[
        'string',
    ],
    names=[
        'string',
    ]
)

type ids:

list

param ids:

A list of collection group IDs. You can't provide names and IDs in the same request.

(string) --

type names:

list

param names:

A list of collection group names. You can't provide names and IDs in the same request.

(string) --

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- collectionGroupDetails (list) --
  
  Details about each collection group.
  - (dict) --
    
    Details about a 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.
    - numberOfCollections (integer) --
      
      The number of collections associated with the collection group.
- collectionGroupErrorDetails (list) --
  
  Error information for the request.
  - (dict) --
    
    Error details for a collection group operation.
    - id (string) --
      
      If the request contains collection group IDs, the response includes the IDs provided in the request.
    - name (string) --
      
      If the request contains collection group names, the response includes the names provided in the request.
    - errorMessage (string) --
      
      A description of the error. For example, The specified Collection Group is not found.
    - errorCode (string) --
      
      The error code for the request. For example, NOT_FOUND.

UpdateCollectionGroup (new)

Link ¶

Updates the description and capacity limits of a collection group.

See also: AWS API Documentation

Request Syntax

client.update_collection_group(
    id='string',
    description='string',
    capacityLimits={
        'maxIndexingCapacityInOCU': ...,
        'maxSearchCapacityInOCU': ...,
        'minIndexingCapacityInOCU': ...,
        'minSearchCapacityInOCU': ...
    },
    clientToken='string'
)

type id:

string

param id:

[REQUIRED]

The unique identifier of the collection group to update.

type description:

string

param description:

A new description for the collection group.

type capacityLimits:

dict

param capacityLimits:

Updated 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.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'updateCollectionGroupDetail': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'capacityLimits': {
            'maxIndexingCapacityInOCU': ...,
            'maxSearchCapacityInOCU': ...,
            'minIndexingCapacityInOCU': ...,
            'minSearchCapacityInOCU': ...
        },
        'createdDate': 123,
        'lastModifiedDate': 123
    }
}

Response Structure

(dict) --
- updateCollectionGroupDetail (dict) --
  
  Details about the updated 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.
  - description (string) --
    
    The description of the collection group.
  - 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.
  - createdDate (integer) --
    
    The Epoch time when the collection group was created.
  - lastModifiedDate (integer) --
    
    The date and time when the collection group was last modified.

DeleteCollectionGroup (new)

Link ¶

Deletes a collection group. You can only delete empty collection groups that contain no collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

See also: AWS API Documentation

Request Syntax

client.delete_collection_group(
    id='string',
    clientToken='string'
)

type id:

string

param id:

[REQUIRED]

The unique identifier of the collection group to delete.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

BatchGetCollection (updated)

Link ¶
Changes (response)

{'collectionDetails': {'collectionGroupName': 'string'}}

Returns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

See also: AWS API Documentation

Request Syntax

client.batch_get_collection(
    ids=[
        'string',
    ],
    names=[
        'string',
    ]
)

type ids:

list

param ids:

A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

(string) --

type names:

list

param names:

A list of collection names. You can't provide names and IDs in the same request.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'collectionDetails': [
        {
            'id': 'string',
            'name': 'string',
            'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED',
            'type': 'SEARCH'|'TIMESERIES'|'VECTORSEARCH',
            'description': 'string',
            'arn': 'string',
            'kmsKeyArn': 'string',
            'standbyReplicas': 'ENABLED'|'DISABLED',
            'vectorOptions': {
                'ServerlessVectorAcceleration': 'ENABLED'|'DISABLED'|'ALLOWED'
            },
            'createdDate': 123,
            'lastModifiedDate': 123,
            'collectionEndpoint': 'string',
            'dashboardEndpoint': 'string',
            'fipsEndpoints': {
                'collectionEndpoint': 'string',
                'dashboardEndpoint': 'string'
            },
            'failureCode': 'string',
            'failureMessage': 'string',
            'collectionGroupName': 'string'
        },
    ],
    'collectionErrorDetails': [
        {
            'id': 'string',
            'name': 'string',
            'errorMessage': 'string',
            'errorCode': 'string'
        },
    ]
}

Response Structure

(dict) --
- collectionDetails (list) --
  
  Details about each collection.
  - (dict) --
    
    Details about each OpenSearch Serverless collection, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints for federal government workloads.
    - id (string) --
      
      A unique identifier for the collection.
    - name (string) --
      
      The name of the collection.
    - status (string) --
      
      The current status of the collection.
    - type (string) --
      
      The type of collection.
    - description (string) --
      
      A description of the collection.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the collection.
    - kmsKeyArn (string) --
      
      The ARN of the Amazon Web Services KMS key used to encrypt the collection.
    - standbyReplicas (string) --
      
      Details about an OpenSearch Serverless collection.
    - vectorOptions (dict) --
      
      Configuration options for vector search capabilities in the collection.
      - ServerlessVectorAcceleration (string) --
        
        Specifies whether serverless vector acceleration is enabled for the collection.
    - createdDate (integer) --
      
      The Epoch time when the collection was created.
    - lastModifiedDate (integer) --
      
      The date and time when the collection was last modified.
    - collectionEndpoint (string) --
      
      Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
    - dashboardEndpoint (string) --
      
      Collection-specific endpoint used to access OpenSearch Dashboards.
    - fipsEndpoints (dict) --
      
      FIPS-compliant endpoints for the collection. These endpoints use FIPS 140-3 validated cryptographic modules and are required for federal government workloads that must comply with FedRAMP security standards.
      - collectionEndpoint (string) --
        
        FIPS-compliant collection endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government workloads.
      - dashboardEndpoint (string) --
        
        FIPS-compliant endpoint used to access OpenSearch Dashboards. This endpoint uses FIPS 140-3 validated cryptography and is required for federal government workloads that need dashboard visualization capabilities.
    - failureCode (string) --
      
      A failure code associated with the request.
    - failureMessage (string) --
      
      A message associated with the failure code.
    - collectionGroupName (string) --
      
      The name of the collection group that contains this collection.
- collectionErrorDetails (list) --
  
  Error information for the request.
  - (dict) --
    
    Error information for an OpenSearch Serverless request.
    - id (string) --
      
      If the request contains collection IDs, the response includes the IDs provided in the request.
    - name (string) --
      
      If the request contains collection names, the response includes the names provided in the request.
    - errorMessage (string) --
      
      A description of the error. For example, The specified Collection is not found.
    - errorCode (string) --
      
      The error code for the request. For example, NOT_FOUND.

CreateCollection (updated)

Link ¶
Changes (request, response)
Request

{'collectionGroupName': 'string',
 'encryptionConfig': {'aWSOwnedKey': 'boolean', 'kmsKeyArn': 'string'}}

Response

{'createCollectionDetail': {'collectionGroupName': 'string'}}

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

See also: AWS API Documentation

Request Syntax

client.create_collection(
    name='string',
    type='SEARCH'|'TIMESERIES'|'VECTORSEARCH',
    description='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    standbyReplicas='ENABLED'|'DISABLED',
    vectorOptions={
        'ServerlessVectorAcceleration': 'ENABLED'|'DISABLED'|'ALLOWED'
    },
    collectionGroupName='string',
    encryptionConfig={
        'aWSOwnedKey': True|False,
        'kmsKeyArn': 'string'
    },
    clientToken='string'
)

type name:

string

param name:

[REQUIRED]

Name of the collection.

type type:

string

param type:

The type of collection.

type description:

string

param description:

Description of the collection.

type tags:

list

param tags:

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

(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.

type standbyReplicas:

string

param standbyReplicas:

Indicates whether standby replicas should be used for a collection.

type vectorOptions:

dict

param vectorOptions:

Configuration options for vector search capabilities in the collection.

ServerlessVectorAcceleration (string) -- [REQUIRED]

Specifies whether serverless vector acceleration is enabled for the collection.

type collectionGroupName:

string

param collectionGroupName:

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

type encryptionConfig:

dict

param encryptionConfig:

Encryption settings for the collection.

aWSOwnedKey (boolean) --

Indicates whether to use an Amazon Web Services-owned key for encryption.
kmsKeyArn (string) --

The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'createCollectionDetail': {
        'id': 'string',
        'name': 'string',
        'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED',
        'type': 'SEARCH'|'TIMESERIES'|'VECTORSEARCH',
        'description': 'string',
        'arn': 'string',
        'kmsKeyArn': 'string',
        'standbyReplicas': 'ENABLED'|'DISABLED',
        'vectorOptions': {
            'ServerlessVectorAcceleration': 'ENABLED'|'DISABLED'|'ALLOWED'
        },
        'createdDate': 123,
        'lastModifiedDate': 123,
        'collectionGroupName': 'string'
    }
}

Response Structure

(dict) --
- createCollectionDetail (dict) --
  
  Details about the collection.
  - id (string) --
    
    The unique identifier of the collection.
  - name (string) --
    
    The name of the collection.
  - status (string) --
    
    The current status of the collection.
  - type (string) --
    
    The type of collection.
  - description (string) --
    
    A description of the collection.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the collection.
  - kmsKeyArn (string) --
    
    The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.
  - standbyReplicas (string) --
    
    Creates details about an OpenSearch Serverless collection.
  - vectorOptions (dict) --
    
    Configuration options for vector search capabilities in the collection.
    - ServerlessVectorAcceleration (string) --
      
      Specifies whether serverless vector acceleration is enabled for the collection.
  - createdDate (integer) --
    
    The Epoch time when the collection was created.
  - lastModifiedDate (integer) --
    
    The date and time when the collection was last modified.
  - collectionGroupName (string) --
    
    The name of the collection group that contains this collection.

ListCollections (updated)

Link ¶
Changes (request, response)
Request

{'collectionFilters': {'collectionGroupName': 'string'}}

Response

{'collectionSummaries': {'collectionGroupName': 'string',
                         'kmsKeyArn': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_collections(
    collectionFilters={
        'name': 'string',
        'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED',
        'collectionGroupName': 'string'
    },
    nextToken='string',
    maxResults=123
)

type collectionFilters:

dict

param collectionFilters:

A list of filter names and values that you can use for requests.

name (string) --

The name of the collection.
status (string) --

The current status of the collection.
collectionGroupName (string) --

The name of the collection group to filter by.

type nextToken:

string

param nextToken:

If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

type maxResults:

integer

param maxResults:

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'collectionSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED',
            'arn': 'string',
            'kmsKeyArn': 'string',
            'collectionGroupName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- collectionSummaries (list) --
  
  Details about each collection.
  - (dict) --
    
    Details about each OpenSearch Serverless collection.
    - id (string) --
      
      The unique identifier of the collection.
    - name (string) --
      
      The name of the collection.
    - status (string) --
      
      The current status of the collection.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the collection.
    - kmsKeyArn (string) --
      
      The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.
    - collectionGroupName (string) --
      
      The name of the collection group that contains this collection.
- nextToken (string) --
  
  When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.