AWS CLI Command Reference

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

Synopsis

  describe-dashboard
--aws-account-id <value>
--dashboard-id <value>
[--version-number <value>]
[--alias-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--aws-account-id (string)

The ID of the Amazon Web Services 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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.

ViolatedEntities -> (list)

Lists the violated entities that caused the dashboard error.

(structure)

An object, structure, or sub-structure of an analysis, template, or dashboard.

Path -> (string)

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

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

Images -> (list)

A list of images on a sheet.

(structure)

An image that is located on a sheet.

SheetImageId -> (string)

The ID of the sheet image.

Source -> (structure)

The source of the image.

SheetImageStaticFileSource -> (structure)

The source of the static file that contains the image.

StaticFileId -> (string)

The ID of the static file that contains the image.

Scaling -> (structure)

Determines how the image is scaled.

ScalingType -> (string)

The scaling option to use when fitting the image inside the container.

Valid values are defined as follows:

  • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
  • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
  • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
  • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.

Tooltip -> (structure)

The tooltip to be shown when hovering over the image.

TooltipText -> (structure)

The text that appears in the tooltip.

PlainText -> (string)

The plain text format.

Visibility -> (string)

The visibility of the tooltip.

ImageContentAltText -> (string)

The alt text for the image.

Interactions -> (structure)

The general image interactions setup for an image.

ImageMenuOption -> (structure)

The menu options for the image.

AvailabilityStatus -> (string)

The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.

Actions -> (list)

A list of custom actions that are configured for an image.

(structure)

A custom action defined on an image.

CustomActionId -> (string)

The ID of the custom action.

Name -> (string)

The name of the custom action.

Status -> (string)

The status of the custom action.

Trigger -> (string)

The trigger of the VisualCustomAction .

Valid values are defined as follows:

  • CLICK : Initiates a custom action by a left pointer click on a data point.
  • MENU : Initiates a custom action by right pointer click from the menu.

ActionOperations -> (list)

A list of ImageCustomActionOperations .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

(structure)

The operation that is defined by the custom action.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

NavigationOperation -> (structure)

The navigation operation that navigates between different sheets in the same analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

LocalNavigationConfiguration -> (structure)

The configuration that chooses the navigation target.

TargetSheetId -> (string)

The sheet that is targeted for navigation in the same analysis.

URLOperation -> (structure)

The URL operation that opens a link to another webpage.

URLTemplate -> (string)

THe URL link of the CustomActionURLOperation .

URLTarget -> (string)

The target of the CustomActionURLOperation .

Valid values are defined as follows:

  • NEW_TAB : Opens the target URL in a new browser tab.
  • NEW_WINDOW : Opens the target URL in a new browser window.
  • SAME_TAB : Opens the target URL in the same browser tab.

SetParametersOperation -> (structure)

The set parameter operation that sets parameters in custom action.

ParameterValueConfigurations -> (list)

The parameter that determines the value configuration.

(structure)

The configuration of adding parameters in action.

DestinationParameterName -> (string)

The destination parameter name of the SetParameterValueConfiguration .

Value -> (structure)

The configuration of destination parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

CustomValuesConfiguration -> (structure)

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .

IncludeNullValue -> (boolean)

Includes the null value in custom action parameter values.

CustomValues -> (structure)

The customized parameter values.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

StringValues -> (list)

A list of string-type parameter values.

(string)

IntegerValues -> (list)

A list of integer-type parameter values.

(long)

DecimalValues -> (list)

A list of decimal-type parameter values.

(double)

DateTimeValues -> (list)

A list of datetime-type parameter values.

(timestamp)

SelectAllValueOptions -> (string)

The configuration that selects all options.

SourceParameterName -> (string)

The source parameter name of the destination parameter.

SourceField -> (string)

The source field ID of the destination parameter.

SourceColumn -> (structure)

A column of a data set.

DataSetIdentifier -> (string)

The data set that the column belongs to.

ColumnName -> (string)

The name of the column.

CreatedTime -> (timestamp)

The time that this dashboard was created.

LastPublishedTime -> (timestamp)

The last time that this dashboard was published.

LastUpdatedTime -> (timestamp)

The last time that this dashboard was updated.

LinkEntities -> (list)

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

(string)

Status -> (integer)

The HTTP status of this request.

RequestId -> (string)

The Amazon Web Services request ID for this operation.