CreateCollectionDetail - Amazon OpenSearch Serverless

CreateCollectionDetail

Details about the created OpenSearch Serverless collection.

Contents

arn

The Amazon Resource Name (ARN) of the collection.

Type: String

Required: No

createdDate

The Epoch time when the collection was created.

Type: Long

Required: No

description

A description of the collection.

Type: String

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 Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.

Type: String

Required: No

lastModifiedDate

The date and time when the collection was last modified.

Type: Long

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

standbyReplicas

Creates details about an OpenSearch Serverless collection.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

status

The current status of the collection.

Type: String

Valid Values: CREATING | DELETING | ACTIVE | FAILED

Required: No

type

The type of collection.

Type: String

Valid Values: SEARCH | TIMESERIES | VECTORSEARCH

Required: No

See Also

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