start_dashboard_refresh¶
Operation¶
async
¶
start_dashboard_refresh(input: StartDashboardRefreshInput, plugins: list[Plugin] | None = None) -> StartDashboardRefreshOutput
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 |
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 |
Input¶
dataclass
¶
Dataclass for StartDashboardRefreshInput structure.
Attributes¶
class-attribute
instance-attribute
¶
dashboard_id: str | None = None
The name or ARN of the dashboard.
class-attribute
instance-attribute
¶
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.