Skip to content

delete_dashboard

Operation

delete_dashboard

delete_dashboard(request: DeleteDashboardInput | DeleteDashboardInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDashboardInputDict]) -> 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
request DeleteDashboardInput | DeleteDashboardInputDict | 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[DeleteDashboardInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDashboardOutput

An instance of DeleteDashboardOutput.

delete_dashboard async

delete_dashboard(request: DeleteDashboardInput | DeleteDashboardInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDashboardInputDict]) -> 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
request DeleteDashboardInput | DeleteDashboardInputDict | 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[DeleteDashboardInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDashboardOutput

An instance of DeleteDashboardOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteDashboardInputDict

Bases: TypedDict

Dictionary form of DeleteDashboardInput.

Attributes

dashboard_id instance-attribute
dashboard_id: Required[str]

The name or ARN for the dashboard.

DeleteDashboardInput dataclass

Bases: _SerdeShape

Dataclass for DeleteDashboardInput structure.

Attributes

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

The name or ARN for the dashboard.

Output

DeleteDashboardOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDashboardOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.