Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account

Create, update, and manage dashboards with the AWS CLI

PDF
RSS
Focus mode
Create, update, and manage dashboards with the AWS CLI - AWS CloudTrail
Available commands for dashboards

This section describes the AWS CLI commands you can use to create, update, and manage your CloudTrail Lake dashboards.

When using the AWS CLI, remember that your commands run in the AWS Region configured for your profile. If you want to run the commands in a different Region, either change the default Region for your profile, or use the --region parameter with the command.

Available commands for dashboards

Commands for creating and updating dashboards in CloudTrail Lake include:

  • create-dashboard to create a custom dashboard or enable the Highlights dashboard.

  • update-dashboard to update a custom dashboard or the Highlights dashboard.

  • delete-dashboard to delete a custom dashboard or the Highlights dashboard.

  • get-dashboard returns information about the specified dashboard.

  • list-dashboards lists all dashboards for your AWS account, or for the specified filter.

  • start-dashboard-refresh starts a refresh of the dashboard.

  • get-resource-policy gets the resource-based policy attached to the dashboard.

  • put-resource-policy attaches a resource-based policy to a dashboard to allow CloudTrail to refresh the dashboard asynchronously on your behalf. You also attach a resource-based policy to an event data store to allow CloudTrail to run queries on the event data store to populate the data for dashboard widgets.

  • delete-resource-policy removes the resource-based policy attached to a dashboard.

  • add-tags adds tags to identify the dashboard.

  • remove-tags removes tags from a dashboard.

  • list-tags lists tags for a dashboard.

For a list of available commands for CloudTrail Lake event data stores, see Available commands for event data stores.

For a list of available commands for CloudTrail Lake queries, see Available commands for CloudTrail Lake queries.

For a list of available commands for CloudTrail Lake integrations, see Available commands for CloudTrail Lake integrations.

Topics:

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.