CollectionDetail
Details about each OpenSearch Serverless collection, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints for federal government workloads.
Contents
- arn
-
The Amazon Resource Name (ARN) of the collection.
Type: String
Required: No
- collectionEndpoint
-
Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless 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
- createdDate
-
The Epoch time when the collection was created.
Type: Long
Required: No
- dashboardEndpoint
-
Collection-specific endpoint used to access OpenSearch Dashboards.
Type: String
Required: No
- description
-
A description of the collection.
Type: String
Required: No
- failureCode
-
A failure code associated with the request.
Type: String
Required: No
- failureMessage
-
A message associated with the failure code.
Type: String
Required: No
- fipsEndpoints
-
FIPS-compliant endpoints for the collection. These endpoints use FIPS 140-3 validated cryptographic modules and are required for federal government workloads that must comply with FedRAMP security standards.
Type: FipsEndpoints object
Required: No
- id
-
A unique identifier for 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 KMS key used 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
-
Details about an OpenSearch Serverless collection.
Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- status
-
The current status of the collection.
Type: String
Valid Values:
CREATING | DELETING | ACTIVE | FAILEDRequired: No
- type
-
The type of collection.
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: