list_dashboards¶
Operation¶
async
¶
list_dashboards(input: ListDashboardsInput, plugins: list[Plugin] | None = None) -> ListDashboardsOutput
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 information about all dashboards in the account, in the current Region.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListDashboardsInput
|
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 |
|---|---|
ListDashboardsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListDashboardsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of dashboards to display on a single page.
class-attribute
instance-attribute
¶
name_prefix: str | None = None
Specify a name prefix to filter on.
Output¶
dataclass
¶
Dataclass for ListDashboardsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
dashboards: list[DashboardDetail] | None = None
Contains information about dashboards in the account, in the current Region that match the applied filters.
class-attribute
instance-attribute
¶
next_token: str | None = None
A token you can use to get the next page of dashboard results.
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.