Module Values.PutDashboardOutputSource

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here. All dashboards in your account are global, not region-specific. A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard. When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

Sourcetype putDashboardResult = {
  1. dashboardValidationMessages : DashboardValidationMessages.t option;
    (*

    If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty. If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard might not render. If this result includes error messages, the input was not valid and the operation failed.

    *)
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. putDashboardResult : putDashboardResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `ConflictException of ConflictException.t
  2. | `DashboardInvalidInputError of DashboardInvalidInputError.t
  3. | `InternalServiceFault of InternalServiceFault.t
  4. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?dashboardValidationMessages:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ConflictException of ConflictException.t | `DashboardInvalidInputError of DashboardInvalidInputError.t | `InternalServiceFault of InternalServiceFault.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ConflictException of ConflictException.t | `DashboardInvalidInputError of DashboardInvalidInputError.t | `InternalServiceFault of InternalServiceFault.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of DataPath.t ]) list ] 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