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 ]

create-dashboard¶

Description¶

Creates a custom dashboard or the Highlights dashboard.

Custom dashboards - Custom dashboards allow you to query events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule.
Highlights dashboard - You can create the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule.

CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide .

To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide .

For more information about dashboards, see CloudTrail Lake dashboards in the CloudTrail User Guide .

Synopsis¶

  create-dashboard
--name <value>
[--refresh-schedule <value>]
[--tags-list <value>]
[--termination-protection-enabled | --no-termination-protection-enabled]
[--widgets <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¶

--name (string)

The name of the dashboard. The name must be unique to your account.

To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights .

--refresh-schedule (structure)

The refresh schedule configuration for the dashboard.

To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED . The Unit for the refresh schedule must be HOURS and the Value must be 6 .

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.

Shorthand Syntax:

Frequency={Unit=string,Value=integer},Status=string,TimeOfDay=string

JSON Syntax:

{
  "Frequency": {
    "Unit": "HOURS"|"DAYS",
    "Value": integer
  },
  "Status": "ENABLED"|"DISABLED",
  "TimeOfDay": "string"
}

--tags-list (list)

A list of tags.

(structure)

A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, dashboard, or channel.

Key -> (string)

The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

Value -> (string)

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--termination-protection-enabled | --no-termination-protection-enabled (boolean)

Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.

--widgets (list)

An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.

You do not need to specify widgets for the Highlights dashboard.

(structure)

Contains information about a widget on a CloudTrail Lake dashboard.

QueryStatement -> (string)

The query statement for the widget. For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account.

Note
When a query uses ? with eventTime , ? must be surrounded by single quotes as follows: '?' .

QueryParameters -> (list)

The optional query parameters. The following query parameters are valid: $StartTime$ , $EndTime$ , and $Period$ .

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

Shorthand Syntax:

QueryStatement=string,QueryParameters=string,string,ViewProperties={KeyName1=string,KeyName2=string} ...

JSON Syntax:

[
  {
    "QueryStatement": "string",
    "QueryParameters": ["string", ...],
    "ViewProperties": {"string": "string"
      ...}
  }
  ...
]

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

Name -> (string)

The name of the dashboard.

Type -> (string)

The dashboard type.

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)

TagsList -> (list)

A list of tags.

(structure)

A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, dashboard, or channel.

Key -> (string)

The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

Value -> (string)

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

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.

TerminationProtectionEnabled -> (boolean)

Indicates whether termination protection is enabled for the dashboard.

Table Of Contents

Feedback

User Guide

Note:

create-dashboard¶

Description¶

Synopsis¶

Options¶

Note

Global Options¶

Output¶