Module Values.GetCapabilityResponseSource

The result of a GetCapability request. Contains details about the capability.

Sourcetype nonrec t = {
  1. capabilityName : CapabilityName.t option;
    (*

    The name of the capability.

    *)
  2. applicationId : ApplicationId.t option;
    (*

    The unique identifier of the OpenSearch UI application.

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

    The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.

    *)
  4. capabilityConfig : CapabilityExtendedResponseConfig.t option;
    (*

    The configuration settings for the capability, including capability-specific settings such as AI configuration.

    *)
  5. failures : CapabilityFailures.t option;
    (*

    A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `DisabledOperationException of DisabledOperationException.t
  3. | `InternalException of InternalException.t
  4. | `ResourceNotFoundException of ResourceNotFoundException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?capabilityName:??? -> ?applicationId:??? -> ?status:??? -> ?capabilityConfig:??? -> ?failures:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of unit | `DisabledOperationException of unit | `InternalException of unit | `ResourceNotFoundException of unit | `Unknown_operation_error of string * string option | `ValidationException of unit ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of unit | `DisabledOperationException of unit | `InternalException of unit | `ResourceNotFoundException of unit | `Unknown_operation_error of string * string option | `ValidationException of unit ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of CapabilityFailureDetails.t ]) list ] list | `String of CapabilityName.t | `Structure of (string * [> `Structure of 'a list ]) 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