Skip to content

CloudTrail  >  Operations  >  delete_dashboard

delete_dashboard

Operation

delete_dashboard async 

delete_dashboard(input: DeleteDashboardInput, plugins: list[Plugin] | None = None) -> DeleteDashboardOutput
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.

Deletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.

Parameters:

Name Type Description Default
input DeleteDashboardInput

An instance of DeleteDashboardInput.

 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
DeleteDashboardOutput

An instance of DeleteDashboardOutput.

Input

DeleteDashboardInput dataclass

Dataclass for DeleteDashboardInput structure.

Attributes

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

The name or ARN for the dashboard.

Output

DeleteDashboardOutput dataclass

Dataclass for DeleteDashboardOutput structure.

Attributes

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.