Module Values.CreateDashboardResponseSource

Creates a custom dashboard or the Highlights dashboard. Custom dashboards - Custom dashboards allow you to query events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule. Highlights dashboard - You can create the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule. CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide. To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide. For more information about dashboards, see CloudTrail Lake dashboards in the CloudTrail User Guide.

Sourcetype nonrec t = {
  1. dashboardArn : DashboardArn.t option;
    (*

    The ARN for the dashboard.

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

    The name of the dashboard.

    *)
  3. type_ : DashboardType.t option;
    (*

    The dashboard type.

    *)
  4. widgets : WidgetList.t option;
    (*

    An array of widgets for the dashboard.

    *)
  5. tagsList : TagsList.t option;
  6. refreshSchedule : RefreshSchedule.t option;
    (*

    The refresh schedule for the dashboard, if configured.

    *)
  7. terminationProtectionEnabled : TerminationProtectionEnabled.t option;
    (*

    Indicates whether termination protection is enabled for the dashboard.

    *)
}
Sourcetype nonrec error = [
  1. | `ConflictException of ConflictException.t
  2. | `EventDataStoreNotFoundException of EventDataStoreNotFoundException.t
  3. | `InactiveEventDataStoreException of InactiveEventDataStoreException.t
  4. | `InsufficientEncryptionPolicyException of InsufficientEncryptionPolicyException.t
  5. | `InvalidQueryStatementException of InvalidQueryStatementException.t
  6. | `InvalidTagParameterException of InvalidTagParameterException.t
  7. | `ServiceQuotaExceededException of ServiceQuotaExceededException.t
  8. | `UnsupportedOperationException of UnsupportedOperationException.t
  9. | `Unknown_operation_error of string * string option
]
Sourceval make : ?dashboardArn:??? -> ?name:??? -> ?type_:??? -> ?widgets:??? -> ?tagsList:??? -> ?refreshSchedule:??? -> ?terminationProtectionEnabled:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ConflictException of unit | `EventDataStoreNotFoundException of unit | `InactiveEventDataStoreException of unit | `InsufficientEncryptionPolicyException of unit | `InvalidQueryStatementException of unit | `InvalidTagParameterException of unit | `ServiceQuotaExceededException of unit | `Unknown_operation_error of string * string option | `UnsupportedOperationException of unit ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ConflictException of unit | `EventDataStoreNotFoundException of unit | `InactiveEventDataStoreException of unit | `InsufficientEncryptionPolicyException of unit | `InvalidQueryStatementException of unit | `InvalidTagParameterException of unit | `ServiceQuotaExceededException of unit | `Unknown_operation_error of string * string option | `UnsupportedOperationException of unit ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of TerminationProtectionEnabled.t | `Enum of string | `List of [> `Structure of (string * [> `List of [> `String of QueryParameter.t ] list | `Map of ([> `String of ViewPropertiesKey.t ] * [> `String of ViewPropertiesValue.t ]) list | `String of QueryAlias.t ]) list ] list | `String of DashboardArn.t | `Structure of (string * [> `Enum of string | `String of TimeOfDay.t | `Structure of (string * [> `Enum of string | `Integer of RefreshScheduleFrequencyValue.t ]) 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