Skip to content

CloudTrail  >  Operations  >  start_dashboard_refresh

start_dashboard_refresh

Operation

start_dashboard_refresh async 

start_dashboard_refresh(input: StartDashboardRefreshInput, plugins: list[Plugin] | None = None) -> StartDashboardRefreshOutput
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.

Parameters:

Name Type Description Default
input StartDashboardRefreshInput

An instance of StartDashboardRefreshInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
StartDashboardRefreshOutput

An instance of StartDashboardRefreshOutput.

Input

StartDashboardRefreshInput dataclass

Dataclass for StartDashboardRefreshInput structure.

Attributes

dashboard_id class-attribute instance-attribute 
dashboard_id: str | None = None

The name or ARN of the dashboard.

query_parameter_values class-attribute instance-attribute 
query_parameter_values: dict[str, str] | None = None

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.

Output

StartDashboardRefreshOutput dataclass

Dataclass for StartDashboardRefreshOutput structure.

Attributes

refresh_id class-attribute instance-attribute 
refresh_id: str | None = None

The refresh ID for the dashboard.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.