Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

update-dashboard

Description

Updates a dashboard in an AWS account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-dashboard
--aws-account-id <value>
--dashboard-id <value>
--name <value>
--source-entity <value>
[--parameters <value>]
[--version-description <value>]
[--dashboard-publish-options <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID of the AWS account that contains the dashboard that you're updating.

--dashboard-id (string)

The ID for the dashboard.

--name (string)

The display name of the dashboard.

--source-entity (structure)

The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the Amazon Resource Name (ARN) of the template and also references to replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.

JSON Syntax:

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

--parameters (structure)

A structure that contains the parameters of the dashboard.

JSON Syntax:

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

--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 , 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 . The sheet controls pane is collapsed by default when set to true. This option is COLLAPSED by default.

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"
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 Amazon Resource Name (ARN) of the resource.

VersionArn -> (string)

The ARN of the dashboard, including the version number.

DashboardId -> (string)

The ID for the dashboard.

CreationStatus -> (string)

The creation status of the request.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The AWS request ID for this operation.