[ aws . quicksight ]
describe-dashboard¶
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>]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
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 | --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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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
- yaml
- yaml-stream
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input 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.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.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.