getDashboard method

Future<GetDashboardOutput> getDashboard(
  1. {required String dashboardName}
)

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

May throw InvalidParameterValueException. May throw DashboardNotFoundError. May throw InternalServiceFault.

Parameter dashboardName : The name of the dashboard to be described.

Implementation

Future<GetDashboardOutput> getDashboard({
  required String dashboardName,
}) async {
  ArgumentError.checkNotNull(dashboardName, 'dashboardName');
  final $request = <String, dynamic>{};
  $request['DashboardName'] = dashboardName;
  final $result = await _protocol.send(
    $request,
    action: 'GetDashboard',
    version: '2010-08-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['GetDashboardInput'],
    shapes: shapes,
    resultWrapper: 'GetDashboardResult',
  );
  return GetDashboardOutput.fromXml($result);
}