collections_list_only

Lists collections in a region or regions, for all properties use collections

Overview

Name	collections_list_only
Type	Resource
Description	Amazon OpenSearchServerless collection resource
Id	aws.opensearchserverless.collections_list_only

Fields

Name	Datatype	Description
description	string	The description of the collection
id	string	The identifier of the collection
name	string	The name of the collection. The name must meet the following criteria: Unique to your account and AWS Region Starts with a lowercase letter Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-) Contains between 3 and 32 characters
tags	array	List of tags to be added to the resource
arn	string	The Amazon Resource Name (ARN) of the collection.
collection_endpoint	string	The endpoint for the collection.
dashboard_endpoint	string	The OpenSearch Dashboards endpoint for the collection.
type	string	The possible types for the collection
standby_replicas	string	The possible standby replicas for the collection
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all collections in a region.

SELECT
region,
id
FROM aws.opensearchserverless.collections_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the collections_list_only resource, see collections