Module Values.StartSessionsStatisticsAggregationRequestSource

Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

Sourcetype nonrec t = {
  1. farmId : FarmId.t;
    (*

    The identifier of the farm that contains queues or fleets to return statistics for.

    *)
  2. resourceIds : SessionsStatisticsResources.t;
    (*

    A list of fleet IDs or queue IDs to gather statistics for.

    *)
  3. startTime : SyntheticTimestamp_date_time.t;
    (*

    The Linux timestamp of the date and time that the statistics start.

    *)
  4. endTime : SyntheticTimestamp_date_time.t;
    (*

    The Linux timestamp of the date and time that the statistics end.

    *)
  5. timezone : Timezone.t option;
    (*

    The timezone to use for the statistics. Use UTC notation such as "UTC+8."

    *)
  6. period : Period.t option;
    (*

    The period to aggregate the statistics.

    *)
  7. groupBy : UsageGroupBy.t;
    (*

    The field to use to group the statistics.

    *)
  8. statistics : UsageStatistics.t;
    (*

    One to four statistics to return.

    *)
}
Sourceval context_ : string
Sourceval make : ?timezone:??? -> ?period:??? -> farmId:FarmId.t -> resourceIds:SessionsStatisticsResources.t -> startTime:SyntheticTimestamp_date_time.t -> endTime:SyntheticTimestamp_date_time.t -> groupBy:UsageGroupBy.t -> statistics:UsageStatistics.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Enum of string ] list | `String of FarmId.t | `Structure of (string * [> `List of [> `String of QueueId.t ] list ]) list | `Timestamp of SyntheticTimestamp_date_time.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