Values_1.CreateDashboardRequestSourceCreates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
type nonrec t = {awsAccountId : AwsAccountId.t;The ID of the Amazon Web Services account where you want to create the dashboard.
*)dashboardId : Values_0.ShortRestrictiveResourceId.t;The ID for the dashboard, also added to the IAM policy.
*)name : DashboardName.t;The display name of the dashboard.
*)parameters : Parameters.t option;The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
*)permissions : ResourcePermissionList.t option;A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN. To specify no permissions, omit the permissions list.
*)sourceEntity : DashboardSourceEntity.t option;The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon Quick Sight-supported Amazon Web Services Region. Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. Either a SourceEntity or a Definition must be provided in order for the request to be valid.
*)versionDescription : VersionDescription.t option;A description for the first version of the dashboard being created.
*)dashboardPublishOptions : DashboardPublishOptions.t option;Options for publishing the dashboard when you create it: 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.
*)themeArn : Values_0.Arn.t option;The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
*)definition : DashboardVersionDefinition.t option;The definition of a dashboard. A definition is the data model of all features in a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition must be provided in order for the request to be valid.
*)validationStrategy : ValidationStrategy.t option;The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.
*)folderArns : FolderArnList.t option;When you create the dashboard, Amazon Quick Sight adds the dashboard to these folders.
*)linkSharingConfiguration : LinkSharingConfiguration.t option;A structure that contains the permissions of a shareable link to the dashboard.
*)linkEntities : LinkEntityArnList.t option;A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
*)}val make :
?parameters:??? ->
?permissions:??? ->
?sourceEntity:??? ->
?tags:??? ->
?versionDescription:??? ->
?dashboardPublishOptions:??? ->
?themeArn:??? ->
?definition:??? ->
?validationStrategy:??? ->
?folderArns:??? ->
?linkSharingConfiguration:??? ->
?linkEntities:??? ->
awsAccountId:AwsAccountId.t ->
dashboardId:Values_0.ShortRestrictiveResourceId.t ->
name:DashboardName.t ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `List of
[> `String of Values_0.Arn.t
| `Structure of
(string
* [> `List of [> `String of string ] list
| `String of Principal.t ])
list ]
list
| `String of AwsAccountId.t
| `Structure of
(string
* [> `Enum of string
| `List of
[> `Structure of
(string
* [> `Enum of string
| `List of
[> `Double of Values_0.SensitiveDouble.t
| `Long of Values_0.SensitiveLong.t
| `String of Values_0.SensitiveString.t
| `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
| `Timestamp of Values_0.SensitiveTimestamp.t ]
list
| `String of Values_0.NonEmptyString.t
| `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
| `Structure of (string * [> `String of string ]) list ]
list
| `String of Values_0.Arn.t
| `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 ]