Skip to contents

Creates a dashboard from either a template or directly with a DashboardDefinition

Source: R/quicksight_operations.R
quicksight_create_dashboard.Rd

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the create_template API operation.

See https://www.paws-r-sdk.com/docs/quicksight_create_dashboard/ for full documentation.

Usage

quicksight_create_dashboard(
  AwsAccountId,
  DashboardId,
  Name,
  Parameters = NULL,
  Permissions = NULL,
  SourceEntity = NULL,
  Tags = NULL,
  VersionDescription = NULL,
  DashboardPublishOptions = NULL,
  ThemeArn = NULL,
  Definition = NULL,
  ValidationStrategy = NULL,
  FolderArns = NULL,
  LinkSharingConfiguration = NULL,
  LinkEntities = NULL
)

Arguments

AwsAccountId

[required] The ID of the Amazon Web Services account where you want to create the dashboard.

DashboardId

[required] The ID for the dashboard, also added to the IAM policy.

Name

[required] The display name of the dashboard.

Parameters

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

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

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 create_template 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.

Tags

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

VersionDescription

A description for the first version of the dashboard being created.

DashboardPublishOptions

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

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

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

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

FolderArns

When you create the dashboard, Amazon Quick Sight adds the dashboard to these folders.

LinkSharingConfiguration

A structure that contains the permissions of a shareable link to the dashboard.

LinkEntities

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.