Module Values.CollectionDetailSource

Details about each OpenSearch Serverless collection, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints for federal government workloads.

Sourcetype nonrec t = {
  1. id : CollectionId.t option;
    (*

    A unique identifier for the collection.

    *)
  2. name : CollectionName.t option;
    (*

    The name of the collection.

    *)
  3. status : CollectionStatus.t option;
    (*

    The current status of the collection.

    *)
  4. type_ : CollectionType.t option;
    (*

    The type of collection.

    *)
  5. description : String_.t option;
    (*

    A description of the collection.

    *)
  6. arn : String_.t option;
    (*

    The Amazon Resource Name (ARN) of the collection.

    *)
  7. kmsKeyArn : String_.t option;
    (*

    The ARN of the Amazon Web Services KMS key used to encrypt the collection.

    *)
  8. standbyReplicas : StandbyReplicas.t option;
    (*

    Details about an OpenSearch Serverless collection.

    *)
  9. vectorOptions : VectorOptions.t option;
    (*

    Configuration options for vector search capabilities in the collection.

    *)
  10. createdDate : Long.t option;
    (*

    The Epoch time when the collection was created.

    *)
  11. lastModifiedDate : Long.t option;
    (*

    The date and time when the collection was last modified.

    *)
  12. collectionEndpoint : String_.t option;
    (*

    Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

    *)
  13. dashboardEndpoint : String_.t option;
    (*

    Collection-specific endpoint used to access OpenSearch Dashboards.

    *)
  14. fipsEndpoints : FipsEndpoints.t option;
    (*

    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.

    *)
  15. failureCode : String_.t option;
    (*

    A failure code associated with the request.

    *)
  16. failureMessage : String_.t option;
    (*

    A message associated with the failure code.

    *)
  17. collectionGroupName : CollectionGroupName.t option;
    (*

    The name of the collection group that contains this collection.

    *)
}
Sourceval make : ?id:??? -> ?name:??? -> ?status:??? -> ?type_:??? -> ?description:??? -> ?arn:??? -> ?kmsKeyArn:??? -> ?standbyReplicas:??? -> ?vectorOptions:??? -> ?createdDate:??? -> ?lastModifiedDate:??? -> ?collectionEndpoint:??? -> ?dashboardEndpoint:??? -> ?fipsEndpoints:??? -> ?failureCode:??? -> ?failureMessage:??? -> ?collectionGroupName:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Long of Long.t | `String of CollectionId.t | `Structure of (string * [> `Enum of string | `String of String_.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t