collection

Gets an individual collection resource

Overview

Name	collection
Type	Resource
Description	collection
Id	awscc.opensearchserverless.collection

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.<br/><br/>The name must meet the following criteria:<br/>Unique to your account and AWS Region<br/>Starts with a lowercase letter<br/>Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)<br/>Contains between 3 and 32 characters<br/>
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
standby_replicas	string
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
description,
id,
name,
tags,
arn,
collection_endpoint,
dashboard_endpoint,
type,
standby_replicas
FROM awscc.opensearchserverless.collection
WHERE data__Identifier = '<Id>';

Permissions

To operate on the collection resource, the following permissions are required:

Delete

aoss:DeleteCollection,
aoss:BatchGetCollection

Read

aoss:BatchGetCollection

Update

aoss:UpdateCollection,
aoss:BatchGetCollection