get_dashboard¶
Operation¶
async
¶
get_dashboard(input: GetDashboardInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
GetDashboardInput
|
An instance of |
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 |
Input¶
dataclass
¶
Output¶
dataclass
¶
Dataclass for GetDashboardOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
created_timestamp: datetime | None = None
The timestamp that shows when the dashboard was created.
class-attribute
instance-attribute
¶
dashboard_arn: str | None = None
The ARN for the dashboard.
class-attribute
instance-attribute
¶
last_refresh_failure_reason: str | None = None
Provides information about failures for the last scheduled refresh.
class-attribute
instance-attribute
¶
last_refresh_id: str | None = None
The ID of the last dashboard refresh.
class-attribute
instance-attribute
¶
refresh_schedule: RefreshSchedule | None = None
The refresh schedule for the dashboard, if configured.
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.
class-attribute
instance-attribute
¶
termination_protection_enabled: bool | None = None
Indicates whether termination protection is enabled for the dashboard.