listDashboards method

Future<ListDashboardsResponse> listDashboards({
  1. required String awsAccountId,
  2. int? maxResults,
  3. String? nextToken,
})

Lists dashboards in an AWS account.

May throw ThrottlingException. May throw InvalidNextTokenException. May throw UnsupportedUserEditionException. May throw InternalFailureException.

Parameter awsAccountId : The ID of the AWS account that contains the dashboards that you're listing.

Parameter maxResults : The maximum number of results to be returned per request.

Parameter nextToken : The token for the next set of results, or null if there are no more results.

Implementation

Future<ListDashboardsResponse> listDashboards({
  required String awsAccountId,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(awsAccountId, 'awsAccountId');
  _s.validateStringLength(
    'awsAccountId',
    awsAccountId,
    12,
    12,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'max-results': [maxResults.toString()],
    if (nextToken != null) 'next-token': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/accounts/${Uri.encodeComponent(awsAccountId)}/dashboards',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListDashboardsResponse.fromJson(response);
}