Module Values.DescribeAccessControlConfigurationResponseSource

Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Sourcetype nonrec t = {
  1. name : AccessControlConfigurationName.t option;
    (*

    The name for the access control configuration.

    *)
  2. description : Description.t option;
    (*

    The description for the access control configuration.

    *)
  3. errorMessage : ErrorMessage.t option;
    (*

    The error message containing details if there are issues processing the access control configuration.

    *)
  4. accessControlList : PrincipalList.t option;
    (*

    Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

    *)
  5. hierarchicalAccessControlList : HierarchicalPrincipalList.t option;
    (*

    The list of principal lists that define the hierarchy for which documents users should have access to.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?name:??? -> ?description:??? -> ?errorMessage:??? -> ?accessControlList:??? -> ?hierarchicalAccessControlList:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of PrincipalName.t ]) list ] list | `String of PrincipalName.t ]) list ] list | `String of AccessControlConfigurationName.t ]) 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