CollectionSummary - Amazon OpenSearch Serverless
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

CollectionSummary

Details about each OpenSearch Serverless collection.

Contents

arn

The Amazon Resource Name (ARN) of the collection.

Type: String

Required: No

collectionGroupName

The name of the collection group that contains this collection.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 32.

Pattern: [a-z][a-z0-9-]+

Required: No

id

The unique identifier of the collection.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: [a-z0-9]{3,40}

Required: No

kmsKeyArn

The ARN of the AWS Key Management Service key used to encrypt the collection.

Type: String

Required: No

name

The name of the collection.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 32.

Pattern: [a-z][a-z0-9-]+

Required: No

status

The current status of the collection.

Type: String

Valid Values: CREATING | DELETING | ACTIVE | FAILED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: