Skip to content

get_dashboard

Operation

get_dashboard

get_dashboard(request: GetDashboardInput | GetDashboardInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDashboardInputDict]) -> GetDashboardOutput
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.

Returns the specified dashboard.

Parameters:

Name Type Description Default
request GetDashboardInput | GetDashboardInputDict | 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[GetDashboardInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDashboardOutput

An instance of GetDashboardOutput.

get_dashboard async

get_dashboard(request: GetDashboardInput | GetDashboardInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDashboardInputDict]) -> GetDashboardOutput
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.

Returns the specified dashboard.

Parameters:

Name Type Description Default
request GetDashboardInput | GetDashboardInputDict | 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[GetDashboardInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDashboardOutput

An instance of GetDashboardOutput.

Input

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

GetDashboardInputDict

Bases: TypedDict

Dictionary form of GetDashboardInput.

Attributes

dashboard_id instance-attribute
dashboard_id: Required[str]

The name or ARN for the dashboard.

GetDashboardInput dataclass

Bases: _SerdeShape

Dataclass for GetDashboardInput structure.

Attributes

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

The name or ARN for the dashboard.

Output

GetDashboardOutput dataclass

Bases: _SerdeShape

Dataclass for GetDashboardOutput structure.

Attributes

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

The timestamp that shows when the dashboard was created.

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

The ARN for the dashboard.

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

Provides information about failures for the last scheduled refresh.

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

The ID of the last dashboard refresh.

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

The refresh schedule for the dashboard, if configured.

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.

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

The status of the dashboard.

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

Indicates whether termination protection is enabled for the dashboard.

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

The type of dashboard.

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

The timestamp that shows when the dashboard was last updated.

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

An array of widgets for the dashboard.