listBackupPlans method

Future<ListBackupPlansOutput> listBackupPlans({ bool? includeDeleted, int? maxResults, String? nextToken, })

Returns a list of existing backup plans for an authenticated account. The list is populated only if the advanced option is set for the backup plan. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

May throw ResourceNotFoundException. May throw InvalidParameterValueException. May throw MissingParameterValueException. May throw ServiceUnavailableException.

Parameter includeDeleted : A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

Parameter maxResults : The maximum number of items to be returned.

Parameter nextToken : The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Implementation

Future<ListBackupPlansOutput> listBackupPlans({
  bool? includeDeleted,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  final $query = <String, List<String>>{
    if (includeDeleted != null) 'includeDeleted': [includeDeleted.toString()],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/backup/plans/',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListBackupPlansOutput.fromJson(response);
}