Skip to content

CloudTrail  >  Operations  >  update_dashboard

update_dashboard

Operation

update_dashboard async 

update_dashboard(input: UpdateDashboardInput, plugins: list[Plugin] | None = None) -> UpdateDashboardOutput

Updates the specified dashboard.

To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide.

CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. 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 UpdateDashboardInput

An instance of UpdateDashboardInput.

 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
UpdateDashboardOutput

An instance of UpdateDashboardOutput.

Input

UpdateDashboardInput dataclass

Dataclass for UpdateDashboardInput structure.

Attributes

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

The name or ARN of the dashboard.

refresh_schedule class-attribute instance-attribute 
refresh_schedule: RefreshSchedule | None = None

The refresh schedule configuration for the dashboard.

termination_protection_enabled class-attribute instance-attribute 
termination_protection_enabled: bool | None = None

Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.

widgets class-attribute instance-attribute 
widgets: list[RequestWidget] | None = None

An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.

To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard.

To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

Output

UpdateDashboardOutput dataclass

Dataclass for UpdateDashboardOutput structure.

Attributes

created_timestamp class-attribute instance-attribute 
created_timestamp: datetime | None = None

The timestamp that shows when the dashboard was created.

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

The ARN for the dashboard.

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

The name for the dashboard.

refresh_schedule class-attribute instance-attribute 
refresh_schedule: RefreshSchedule | None = None

The refresh schedule for the dashboard, if configured.

termination_protection_enabled class-attribute instance-attribute 
termination_protection_enabled: bool | None = None

Indicates whether termination protection is enabled for the dashboard.

type class-attribute instance-attribute 
type: DashboardType | None = None

The type of dashboard.

updated_timestamp class-attribute instance-attribute 
updated_timestamp: datetime | None = None

The timestamp that shows when the dashboard was updated.

widgets class-attribute instance-attribute 
widgets: list[Widget] | None = None

An array of widgets for the dashboard.