create-dashboard¶

Description¶

Creates a dashboard from a template. To first create a template, see the `` CreateTemplate `` API operation.

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight 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.

Synopsis¶

  create-dashboard
--aws-account-id <value>
--dashboard-id <value>
--name <value>
[--parameters <value>]
[--permissions <value>]
--source-entity <value>
[--tags <value>]
[--version-description <value>]
[--dashboard-publish-options <value>]
[--theme-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--aws-account-id (string)

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

--dashboard-id (string)

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

--name (string)

The display name of the dashboard.

--parameters (structure)

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.

StringParameters -> (list)

The parameters that have a data type of string.

(structure)

A string parameter.

Name -> (string)

A display name for a string parameter.

Values -> (list)

The values of a string parameter.

(string)

IntegerParameters -> (list)

The parameters that have a data type of integer.

(structure)

An integer parameter.

Name -> (string)

The name of the integer parameter.

Values -> (list)

The values for the integer parameter.

(long)

DecimalParameters -> (list)

The parameters that have a data type of decimal.

(structure)

A decimal parameter.

Name -> (string)

A display name for the decimal parameter.

Values -> (list)

The values for the decimal parameter.

(double)

DateTimeParameters -> (list)

The parameters that have a data type of date-time.

(structure)

A date-time parameter.

Name -> (string)

A display name for the date-time parameter.

Values -> (list)

The values for the date-time parameter.

(timestamp)

JSON Syntax:

{
  "StringParameters": [
    {
      "Name": "string",
      "Values": ["string", ...]
    }
    ...
  ],
  "IntegerParameters": [
    {
      "Name": "string",
      "Values": [long, ...]
    }
    ...
  ],
  "DecimalParameters": [
    {
      "Name": "string",
      "Values": [double, ...]
    }
    ...
  ],
  "DateTimeParameters": [
    {
      "Name": "string",
      "Values": [timestamp, ...]
    }
    ...
  ]
}

--permissions (list)

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.

(structure)

Permission for the resource.

Principal -> (string)

The Amazon Resource Name (ARN) of the principal. This can be one of the following:

The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)

Actions -> (list)

The IAM action to grant or revoke permissions on.

(string)

Shorthand Syntax:

Principal=string,Actions=string,string ...

JSON Syntax:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

--source-entity (structure)

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 SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-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.

SourceTemplate -> (structure)

Source template.

DataSetReferences -> (list)

Dataset references.

(structure)

Dataset reference.

DataSetPlaceholder -> (string)

Dataset placeholder.

DataSetArn -> (string)

Dataset Amazon Resource Name (ARN).

Arn -> (string)

The Amazon Resource Name (ARN) of the resource.

JSON Syntax:

{
  "SourceTemplate": {
    "DataSetReferences": [
      {
        "DataSetPlaceholder": "string",
        "DataSetArn": "string"
      }
      ...
    ],
    "Arn": "string"
  }
}

--tags (list)

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

(structure)

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

Key -> (string)

Tag key.

Value -> (string)

Tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--version-description (string)

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

--dashboard-publish-options (structure)

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

AdHocFilteringOption -> (structure)

Ad hoc (one-time) filtering option.

AvailabilityStatus -> (string)

Availability status.

ExportToCSVOption -> (structure)

Export to .csv option.

AvailabilityStatus -> (string)

Availability status.

SheetControlsOption -> (structure)

Sheet controls option.

VisibilityState -> (string)

Visibility state.

Shorthand Syntax:

AdHocFilteringOption={AvailabilityStatus=string},ExportToCSVOption={AvailabilityStatus=string},SheetControlsOption={VisibilityState=string}

JSON Syntax:

{
  "AdHocFilteringOption": {
    "AvailabilityStatus": "ENABLED"|"DISABLED"
  },
  "ExportToCSVOption": {
    "AvailabilityStatus": "ENABLED"|"DISABLED"
  },
  "SheetControlsOption": {
    "VisibilityState": "EXPANDED"|"COLLAPSED"
  }
}

--theme-arn (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output¶

Arn -> (string)

The ARN of the dashboard.

VersionArn -> (string)

The ARN of the dashboard, including the version number of the first version that is created.

DashboardId -> (string)

The ID for the dashboard.

CreationStatus -> (string)

The status of the dashboard creation request.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Table of Contents

Feedback

User Guide

create-dashboard¶

Description¶

Synopsis¶

Options¶

Output¶