Module Values.ActionReviewPayloadFieldSource

A user input field in an plugin action review payload.

Sourcetype nonrec t = {
  1. displayName : String_.t option;
    (*

    The name of the field.

    *)
  2. displayOrder : Integer.t option;
    (*

    The display order of fields in a payload.

    *)
  3. displayDescription : String_.t option;
    (*

    The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.

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

    The type of field.

    *)
  5. value : ActionPayloadFieldValue.t option;
    (*

    The field value.

    *)
  6. allowedValues : ActionReviewPayloadFieldAllowedValues.t option;
    (*

    Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

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

    The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.

    *)
  8. arrayItemJsonSchema : ActionReviewPayloadFieldArrayItemJsonSchema.t option;
    (*

    Use to create a custom form with array fields (fields with nested objects inside an array).

    *)
  9. required : Boolean.t option;
    (*

    Information about whether the field is required.

    *)
}
Sourceval make : ?displayName:??? -> ?displayOrder:??? -> ?displayDescription:??? -> ?type_:??? -> ?value:??? -> ?allowedValues:??? -> ?allowedFormat:??? -> ?arrayItemJsonSchema:??? -> ?required:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t | `List of [> `Structure of (string * [> `Structure of 'a list ]) list ] list | `String of String_.t | `Structure of 'b 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