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 ]

describe-dashboard

Description

Provides a summary for a dashboard.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-dashboard
--aws-account-id <value>
--dashboard-id <value>
[--version-number <value>]
[--alias-name <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 describing.

--dashboard-id (string)

The ID for the dashboard.

--version-number (long)

The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

--alias-name (string)

The alias name.

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

Dashboard -> (structure)

Information about the dashboard.

DashboardId -> (string)

Dashboard ID.

Arn -> (string)

The Amazon Resource Name (ARN) of the resource.

Name -> (string)

A display name for the dashboard.

Version -> (structure)

Version.

CreatedTime -> (timestamp)

The time that this dashboard version was created.

Errors -> (list)

Errors.

(structure)

Dashboard error.

Type -> (string)

Type.

Message -> (string)

Message.

VersionNumber -> (long)

Version number.

Status -> (string)

The HTTP status of the request.

Arn -> (string)

The Amazon Resource Name (ARN) of the resource.

SourceEntityArn -> (string)

Source entity ARN.

DataSetArns -> (list)

The Amazon Resource Numbers (ARNs) for the datasets that are associated with a version of the dashboard.

(string)

Description -> (string)

Description.

CreatedTime -> (timestamp)

The time that this dataset was created.

LastPublishedTime -> (timestamp)

The last time that this dataset was published.

LastUpdatedTime -> (timestamp)

The last time that this dataset was updated.

Status -> (integer)

The HTTP status of this request.

RequestId -> (string)

The AWS request ID for this operation.