CloudTrail Lake will no longer be open to new customers starting May 31, 2026¶

Description¶

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Starts a refresh of the specified dashboard.

Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the start_query operation on your behalf. To provide permissions, run the put_resource_policy 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.

Usage¶

cloudtrail_start_dashboard_refresh(DashboardId, QueryParameterValues)

Arguments¶

DashboardId

[required] The name or ARN of the dashboard.
QueryParameterValues

The query parameter values for the dashboard

For custom dashboards, the following query parameters are valid: $StartTime$ , $EndTime$ , and $Period$ .

For managed dashboards, the following query parameters are valid: $StartTime$ , $EndTime$ , $Period$ , and $EventDataStoreId$ . The $EventDataStoreId$ query parameter is required.

Value¶

A list with the following syntax:

list(
  RefreshId = "string"
)

Request syntax¶

svc$start_dashboard_refresh(
  DashboardId = "string",
  QueryParameterValues = list(
    "string"
  )
)