Module Values_2.DescribeDashboardDefinitionResponseSource

Provides a detailed description of the definition of a dashboard. If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

Sourcetype nonrec t = {
  1. dashboardId : Values_0.ShortRestrictiveResourceId.t option;
    (*

    The ID of the dashboard described.

    *)
  2. errors : Values_1.DashboardErrorList.t option;
    (*

    Errors associated with this dashboard version.

    *)
  3. name : Values_1.DashboardName.t option;
    (*

    The display name of the dashboard.

    *)
  4. resourceStatus : Values_0.ResourceStatus.t option;
    (*

    Status associated with the dashboard version. CREATION_IN_PROGRESS CREATION_SUCCESSFUL CREATION_FAILED UPDATE_IN_PROGRESS UPDATE_SUCCESSFUL UPDATE_FAILED DELETED

    *)
  5. themeArn : Values_0.Arn.t option;
    (*

    The ARN of the theme of the dashboard.

    *)
  6. definition : Values_1.DashboardVersionDefinition.t option;
    (*

    The definition of a dashboard. A definition is the data model of all features in a Dashboard, Template, or Analysis.

    *)
  7. status : Values_1.StatusCode.t option;
    (*

    The HTTP status of the request.

    *)
  8. requestId : Values_0.String_.t option;
    (*

    The Amazon Web Services request ID for this operation.

    *)
  9. dashboardPublishOptions : Values_1.DashboardPublishOptions.t option;
    (*

    Options for publishing the dashboard: AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default. VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default. AvailabilityStatus for QuickSuiteActionsOption - This status can be either ENABLED or DISABLED. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to DISABLED. This option is DISABLED by default. AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default. AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED by default.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of Values_0.AccessDeniedException.t
  2. | `ConflictException of Values_1.ConflictException.t
  3. | `InternalFailureException of Values_1.InternalFailureException.t
  4. | `InvalidParameterValueException of Values_1.InvalidParameterValueException.t
  5. | `ResourceExistsException of Values_1.ResourceExistsException.t
  6. | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t
  7. | `ThrottlingException of Values_1.ThrottlingException.t
  8. | `UnsupportedUserEditionException of Values_1.UnsupportedUserEditionException.t
  9. | `Unknown_operation_error of string * string option
]
Sourceval make : ?dashboardId:??? -> ?errors:??? -> ?name:??? -> ?resourceStatus:??? -> ?themeArn:??? -> ?definition:??? -> ?status:??? -> ?requestId:??? -> ?dashboardPublishOptions:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of Values_0.AccessDeniedException.t | `ConflictException of Values_1.ConflictException.t | `InternalFailureException of Values_1.InternalFailureException.t | `InvalidParameterValueException of Values_1.InvalidParameterValueException.t | `ResourceExistsException of Values_1.ResourceExistsException.t | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t | `ThrottlingException of Values_1.ThrottlingException.t | `Unknown_operation_error of string * string option | `UnsupportedUserEditionException of Values_1.UnsupportedUserEditionException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of Values_0.AccessDeniedException.t | `ConflictException of Values_1.ConflictException.t | `InternalFailureException of Values_1.InternalFailureException.t | `InvalidParameterValueException of Values_1.InvalidParameterValueException.t | `ResourceExistsException of Values_1.ResourceExistsException.t | `ResourceNotFoundException of Values_1.ResourceNotFoundException.t | `ThrottlingException of Values_1.ThrottlingException.t | `Unknown_operation_error of string * string option | `UnsupportedUserEditionException of Values_1.UnsupportedUserEditionException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of Values_1.StatusCode.t | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of string ]) list ] list | `String of Values_0.NonEmptyString.t ]) list ] list | `String of Values_0.ShortRestrictiveResourceId.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Boolean of bool | `String of string | `Structure of (string * [> `List of [> `Double of float | `Long of Awso.Import.Int64.t | `String of string | `Timestamp of string ] list ]) list ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `String of string ]) list ]) list ]) list ] list | `String of string ]) list ] list | `String of string | `Structure of (string * [> `Boolean of bool | `Double of float | `Enum of string | `Integer of int | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Boolean of bool | `String of string | `Structure of (string * [> `List of [> `Double of float | `Long of Awso.Import.Int64.t | `String of string | `Timestamp of string ] list ]) list ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `List of [> `String of string | `Structure of (string * [> `String of string ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `List of [> `String of string ] list ]) list ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of string | `Structure of (string * [> `Double of float | `Enum of string | `List of [> `String of string ] list | `Structure of (string * [> `String of string ]) list | `Timestamp of string ]) list ]) list ] list | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `String of string | `Structure of (string * [> `Double of float ]) list ]) list ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `Integer of int | `List of [> `String of string | `Structure of (string * [> `Enum of string | `Integer of int | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Boolean of bool | `String of string | `Structure of (string * [> `List of [> `Double of float | `Long of Awso.Import.Int64.t | `String of string | `Timestamp of string ] list ]) list ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `List of [> `String of string | `Structure of (string * [> `String of string ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `List of [> `String of string ] list ]) list ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Double of float | `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Enum of string ]) list ]) list ]) list ]) list ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `Integer of int | `List of [> `String of string | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Integer of int | `List of [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Double of float ]) list ]) list ]) list ]) list ] list | `Structure of (string * [> `String of string ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of string | `Structure of (string * [> `Enum of string ]) list ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Enum of string ]) list ]) list ]) list ]) list ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of string | `Structure of (string * [> `Enum of string ]) list ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `String of string ]) list ]) list ] list | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `List of [> `Structure of (string * [> `Double of float | `String of string ]) list ] list | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `List of [> `Structure of (string * [> `Double of float | `String of string ]) list ] list | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `List of [> `Structure of (string * [> `Double of float | `String of string ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `String of string ]) list ]) list ]) list ]) list ]) list ]) list | `Timestamp of string ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `Integer of int | `List of [> `String of string | `Structure of (string * [> `Double of float | `Enum of string | `Integer of int | `List of [> `Structure of (string * [> `String of string | `Structure of (string * [> `Enum of string ]) list ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of string | `Structure of (string * [> `Enum of string ]) list ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of string | `Structure of (string * [> `Enum of string ]) list ]) list ] list | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Enum of string | `String of string ]) list ]) list ]) list ]) list ]) list ]) list ]) list ] list | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `Integer of int | `List of [> `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Enum of string ]) list ]) list ]) list ]) list ]) list ]) list ]) list ] list | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `Integer of int | `List of [> `String of string | `Structure of (string * [> `String of string ]) list ] list | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `Integer of int | `List of [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Double of float ]) list ]) list ]) list ]) list ]) list ] list | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `Integer of int | `List of [> `String of string ] list | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `Integer of int | `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `String of string ]) list ]) list ]) list ]) list ]) list ]) list ]) list ]) list | `Timestamp of string ]) list | `Timestamp of string ]) list ]) list ] list | `String of string | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of string ]) list ] list | `String of string | `Structure of (string * [> `Double of float | `Enum of string | `List of [> `Double of float | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Enum of string | `List of [> `String of string ] list | `String of string ]) list | `Timestamp of string ] list | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `String of string | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Enum of string | `Long of Awso.Import.Int64.t | `String of string | `Structure of (string * [> `Enum of string ]) list ]) list ]) list ]) list | `Timestamp of string ]) list ]) list ]) list ] list | `Structure of (string * [> `Enum of string | `List of [> `String of string ] list | `String of string | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `String of string ]) list ]) list ]) list ]) list ]) list ]) 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