collections

Creates, updates, deletes, gets or lists a collections resource.

Overview

Name	collections
Type	Resource
Id	aws.opensearchserverless.collections

Fields

The following fields are returned by SELECT queries:

list_collections

Name	Datatype	Description
collection_summaries	array	Details about each collection.
next_token	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_collections	select	region		Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections. Make sure to include an empty request body {} if you don't include any collection filters in the request.
create_collection	insert	region, name		Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
update_collection	update	region, id		Updates an OpenSearch Serverless collection.
delete_collection	delete	region		Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
batch_get_collection	exec	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_collections

Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections. Make sure to include an empty request body {} if you don't include any collection filters in the request.

SELECT
collection_summaries,
next_token
FROM aws.opensearchserverless.collections
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_collection

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

INSERT INTO aws.opensearchserverless.collections (
name,
type,
description,
tags,
standbyReplicas,
vectorOptions,
collectionGroupName,
encryptionConfig,
deletionProtection,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ type }}',
'{{ description }}',
'{{ tags }}',
'{{ standbyReplicas }}',
'{{ vectorOptions }}',
'{{ collectionGroupName }}',
'{{ encryptionConfig }}',
'{{ deletionProtection }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
create_collection_detail
;

Manifest

# Description fields are for documentation purposes
- name: collections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the collections resource.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the collection.
  - name: type
    value: "{{ type }}"
    description: |
      The type of collection.
    valid_values: ['SEARCH', 'TIMESERIES', 'VECTORSEARCH']
  - name: description
    value: "{{ description }}"
    description: |
      Description of the collection.
  - name: tags
    description: |
      An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: standbyReplicas
    value: "{{ standbyReplicas }}"
    description: |
      Indicates whether standby replicas should be used for a collection.
    valid_values: ['ENABLED', 'DISABLED']
  - name: vectorOptions
    description: |
      Configuration options for vector search capabilities in the collection.
    value:
      ServerlessVectorAcceleration: "{{ ServerlessVectorAcceleration }}"
  - name: collectionGroupName
    value: "{{ collectionGroupName }}"
    description: |
      The name of the collection group to associate with the collection.
  - name: encryptionConfig
    description: |
      Encryption settings for the collection.
    value:
      aWSOwnedKey: {{ aWSOwnedKey }}
      kmsKeyArn: "{{ kmsKeyArn }}"
  - name: deletionProtection
    value: "{{ deletionProtection }}"
    description: |
      Indicates whether to enable deletion protection for the collection. When set to ENABLED, the collection cannot be deleted.
    valid_values: ['ENABLED', 'DISABLED']
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Unique, case-sensitive identifier to ensure idempotency of the request.

UPDATE examples

update_collection

Updates an OpenSearch Serverless collection.

UPDATE aws.opensearchserverless.collections
SET 
id = '{{ id }}',
description = '{{ description }}',
vectorOptions = '{{ vectorOptions }}',
deletionProtection = '{{ deletionProtection }}',
clientToken = '{{ clientToken }}'
WHERE 
region = '{{ region }}' --required
AND id = '{{ id }}' --required
RETURNING
update_collection_detail;

DELETE examples

delete_collection

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

DELETE FROM aws.opensearchserverless.collections
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

batch_get_collection

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.

EXEC aws.opensearchserverless.collections.batch_get_collection 
@region='{{ region }}' --required 
@@json=
'{
"ids": "{{ ids }}", 
"names": "{{ names }}"
}'
;