list_dashboards¶
Operation¶
async
¶
list_dashboards(input: ListDashboardsInput, plugins: list[Plugin] | None = None) -> ListDashboardsOutput
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.
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
¶
type: DashboardType | None = None
Specify a dashboard type to filter on: CUSTOM or MANAGED.
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.