[ 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 | --cli-input-yaml]
[--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 | --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

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 associated with this dashboard version.

(structure)

Dashboard error.

Type -> (string)

Type.

Message -> (string)

Message.

VersionNumber -> (long)

Version number for this version of the dashboard.

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 this version of the dashboard.

(string)

Description -> (string)

Description.

ThemeArn -> (string)

The ARN of the theme associated with a version of the dashboard.

Sheets -> (list)

A list of the associated sheets with the unique identifier and name of each sheet.

(structure)

A sheet , which is an object that contains a set of visuals that are viewed together on one page in the Amazon QuickSight console. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

SheetId -> (string)

The unique identifier associated with a sheet.

Name -> (string)

The name of a sheet. This name is displayed on the sheet’s tab in the QuickSight console.

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.