listDashboards method

Future<ListDashboardsOutput> listDashboards({String? dashboardNamePrefix, String? nextToken})

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

May throw InvalidParameterValueException. May throw InternalServiceFault.

Parameter dashboardNamePrefix : If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, ".", "-", and "_".

Parameter nextToken : The token returned by a previous call to indicate that there is more data available.

Implementation

Future<ListDashboardsOutput> listDashboards({
  String? dashboardNamePrefix,
  String? nextToken,
}) async {
  final $request = <String, dynamic>{};
  dashboardNamePrefix?.also((arg) => $request['DashboardNamePrefix'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ListDashboards',
    version: '2010-08-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListDashboardsInput'],
    shapes: shapes,
    resultWrapper: 'ListDashboardsResult',
  );
  return ListDashboardsOutput.fromXml($result);
}