Skip to content

list_dashboards

Operation

list_dashboards

list_dashboards(request: ListDashboardsInput | ListDashboardsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDashboardsInputDict]) -> 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
request ListDashboardsInput | ListDashboardsInputDict | 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[ListDashboardsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDashboardsOutput

An instance of ListDashboardsOutput.

list_dashboards async

list_dashboards(request: ListDashboardsInput | ListDashboardsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDashboardsInputDict]) -> 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
request ListDashboardsInput | ListDashboardsInputDict | 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[ListDashboardsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDashboardsOutput

An instance of ListDashboardsOutput.

Input

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

ListDashboardsInputDict

Bases: TypedDict

Dictionary form of ListDashboardsInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of dashboards to display on a single page.

name_prefix instance-attribute
name_prefix: str | None

Specify a name prefix to filter on.

next_token instance-attribute
next_token: str | None

A token you can use to get the next page of dashboard results.

type instance-attribute
type: str | None

Specify a dashboard type to filter on: CUSTOM or MANAGED.

ListDashboardsInput dataclass

Bases: _SerdeShape

Dataclass for ListDashboardsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of dashboards to display on a single page.

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

Specify a name prefix to filter on.

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

A token you can use to get the next page of dashboard results.

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

Specify a dashboard type to filter on: CUSTOM or MANAGED.

Output

ListDashboardsOutput dataclass

Bases: _SerdeShape

Dataclass for ListDashboardsOutput structure.

Attributes

dashboards class-attribute instance-attribute
dashboards: list[DashboardDetail] | None = ...

Contains information about dashboards in the account, in the current Region that match the applied filters.

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

A token you can use to get the next page of dashboard results.

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.