UpdateCollectionDetail
Details about an updated OpenSearch Serverless collection.
Contents
- arn
-
The Amazon Resource Name (ARN) of the collection.
Type: String
Required: No
- createdDate
-
The date and time when the collection was created.
Type: Long
Required: No
- deletionProtection
-
Indicates whether deletion protection is
ENABLEDorDISABLEDfor the collection.Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- description
-
The 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
- 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 64.
Pattern:
[a-z][a-z0-9-]+Required: No
- status
-
The current status of the collection.
Type: String
Valid Values:
CREATING | UPDATING | DELETING | ACTIVE | FAILED | UPDATE_FAILEDRequired: No
- type
-
The collection type.
Type: String
Valid Values:
SEARCH | TIMESERIES | VECTORSEARCHRequired: No
- vectorOptions
-
Configuration options for vector search capabilities in the collection.
Type: VectorOptions object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: