CloudTrail / Client / start_dashboard_refresh

start_dashboard_refresh¶

CloudTrail.Client.start_dashboard_refresh(**kwargs)¶

Warning

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

Request Syntax

response = client.start_dashboard_refresh(
    DashboardId='string',
    QueryParameterValues={
        'string': 'string'
    }
)

Parameters:

DashboardId (string) –
[REQUIRED]

The name or ARN of the dashboard.
QueryParameterValues (dict) –
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.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RefreshId': 'string'
}

Response Structure

(dict) –
- RefreshId (string) –
  
  The refresh ID for the dashboard.

Exceptions

CloudTrail.Client.exceptions.ResourceNotFoundException
CloudTrail.Client.exceptions.EventDataStoreNotFoundException
CloudTrail.Client.exceptions.InactiveEventDataStoreException
CloudTrail.Client.exceptions.ServiceQuotaExceededException
CloudTrail.Client.exceptions.UnsupportedOperationException