AWS API Changes

2026/03/24 - OpenSearch Service Serverless - 5 updated api methods

Changes Adds support for updating the vector options field for existing collections.

BatchGetCollection (updated)

Link ¶
Changes (response)

{'collectionDetails': {'status': {'UPDATE_FAILED', 'UPDATING'}}}

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'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED'|'UPDATE_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 (response)

{'createCollectionDetail': {'status': {'UPDATE_FAILED', 'UPDATING'}}}

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'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED'|'UPDATE_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.

DeleteCollection (updated)

Link ¶
Changes (response)

{'deleteCollectionDetail': {'status': {'UPDATE_FAILED', 'UPDATING'}}}

Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

See also: AWS API Documentation

Request Syntax

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

type id:

string

param id:

[REQUIRED]

The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'deleteCollectionDetail': {
        'id': 'string',
        'name': 'string',
        'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED'|'UPDATE_FAILED'
    }
}

Response Structure

(dict) --
- deleteCollectionDetail (dict) --
  
  Details of the deleted collection.
  - id (string) --
    
    The unique identifier of the collection.
  - name (string) --
    
    The name of the collection.
  - status (string) --
    
    The current status of the collection.

ListCollections (updated)

Link ¶
Changes (request, response)
Request

{'collectionFilters': {'status': {'UPDATE_FAILED', 'UPDATING'}}}

Response

{'collectionSummaries': {'status': {'UPDATE_FAILED', 'UPDATING'}}}

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'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED'|'UPDATE_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'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED'|'UPDATE_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.

UpdateCollection (updated)

Link ¶
Changes (request, response)
Request

{'vectorOptions': {'ServerlessVectorAcceleration': 'ENABLED | DISABLED | '
                                                   'ALLOWED'}}

Response

{'updateCollectionDetail': {'status': {'UPDATE_FAILED', 'UPDATING'},
                            'vectorOptions': {'ServerlessVectorAcceleration': 'ENABLED '
                                                                              '| '
                                                                              'DISABLED '
                                                                              '| '
                                                                              'ALLOWED'}}}

Updates an OpenSearch Serverless collection.

See also: AWS API Documentation

Request Syntax

client.update_collection(
    id='string',
    description='string',
    vectorOptions={
        'ServerlessVectorAcceleration': 'ENABLED'|'DISABLED'|'ALLOWED'
    },
    clientToken='string'
)

type id:

string

param id:

[REQUIRED]

The unique identifier of the collection.

type description:

string

param description:

A description of the 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 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

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

Response Structure

(dict) --
- updateCollectionDetail (dict) --
  
  Details about the updated 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 collection type.
  - description (string) --
    
    The description of the collection.
  - vectorOptions (dict) --
    
    Configuration options for vector search capabilities in the collection.
    - ServerlessVectorAcceleration (string) --
      
      Specifies whether serverless vector acceleration is enabled for the collection.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the collection.
  - createdDate (integer) --
    
    The date and time when the collection was created.
  - lastModifiedDate (integer) --
    
    The date and time when the collection was last modified.