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 . cloudtrail ]

get-dashboard

Description

Returns the specified dashboard.

See also: AWS API Documentation

Synopsis

  get-dashboard
--dashboard-id <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

--dashboard-id (string)

The name or ARN for the dashboard.

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

DashboardArn -> (string)

The ARN for the dashboard.

Type -> (string)

The type of dashboard.

Status -> (string)

The status of the dashboard.

Widgets -> (list)

An array of widgets for the dashboard.

(structure)

A widget on a CloudTrail Lake dashboard.

QueryAlias -> (string)

The query alias used to identify the query for the widget.

QueryStatement -> (string)

The SQL query statement for the widget.

QueryParameters -> (list)

The query parameters for the widget.

(string)

ViewProperties -> (map)

The view properties for the widget. For more information about view properties, see View properties for widgets in the CloudTrail User Guide ..

key -> (string)

value -> (string)

RefreshSchedule -> (structure)

The refresh schedule for the dashboard, if configured.

Frequency -> (structure)

The frequency at which you want the dashboard refreshed.

Unit -> (string)

The unit to use for the refresh.

For custom dashboards, the unit can be HOURS or DAYS .

For the Highlights dashboard, the Unit must be HOURS .

Value -> (integer)

The value for the refresh schedule.

For custom dashboards, the following values are valid when the unit is HOURS : 1 , 6 , 12 , 24

For custom dashboards, the only valid value when the unit is DAYS is 1 .

For the Highlights dashboard, the Value must be 6 .

Status -> (string)

Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.

TimeOfDay -> (string)

The time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.

CreatedTimestamp -> (timestamp)

The timestamp that shows when the dashboard was created.

UpdatedTimestamp -> (timestamp)

The timestamp that shows when the dashboard was last updated.

LastRefreshId -> (string)

The ID of the last dashboard refresh.

LastRefreshFailureReason -> (string)

Provides information about failures for the last scheduled refresh.

TerminationProtectionEnabled -> (boolean)

Indicates whether termination protection is enabled for the dashboard.