Skip to content

CloudTrail  >  Operations  >  get_dashboard

get_dashboard

Operation

get_dashboard async 

get_dashboard(input: GetDashboardInput, plugins: list[Plugin] | None = None) -> GetDashboardOutput

Returns the specified dashboard.

Parameters:

Name Type Description Default
input GetDashboardInput

An instance of GetDashboardInput.

 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
GetDashboardOutput

An instance of GetDashboardOutput.

Input

GetDashboardInput dataclass

Dataclass for GetDashboardInput structure.

Attributes

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

The name or ARN for the dashboard.

Output

GetDashboardOutput dataclass

Dataclass for GetDashboardOutput 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.

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

Provides information about failures for the last scheduled refresh.

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

The ID of the last dashboard refresh.

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

The refresh schedule for the dashboard, if configured.

status class-attribute instance-attribute 
status: DashboardStatus | None = None

The status of the dashboard.

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 last updated.

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

An array of widgets for the dashboard.