start_dashboard_refresh¶
Operation¶
start_dashboard_refresh
¶
start_dashboard_refresh(request: StartDashboardRefreshInput | StartDashboardRefreshInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartDashboardRefreshInputDict]) -> 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 |
|---|---|---|---|
request
|
StartDashboardRefreshInput | StartDashboardRefreshInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[StartDashboardRefreshInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartDashboardRefreshOutput
|
An instance of |
start_dashboard_refresh
async
¶
start_dashboard_refresh(request: StartDashboardRefreshInput | StartDashboardRefreshInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartDashboardRefreshInputDict]) -> 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 |
|---|---|---|---|
request
|
StartDashboardRefreshInput | StartDashboardRefreshInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[StartDashboardRefreshInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartDashboardRefreshOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
StartDashboardRefreshInputDict
¶
Bases: TypedDict
Dictionary form of StartDashboardRefreshInput.
Attributes¶
query_parameter_values
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.
StartDashboardRefreshInput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartDashboardRefreshInput structure.
Attributes¶
dashboard_id
class-attribute
instance-attribute
¶
dashboard_id: str | None = ...
The name or ARN of the dashboard.
query_parameter_values
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.
Output¶
StartDashboardRefreshOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartDashboardRefreshOutput structure.
Attributes¶
refresh_id
class-attribute
instance-attribute
¶
refresh_id: str | None = ...
The refresh ID for the dashboard.
response_metadata
class-attribute
instance-attribute
¶
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.