describeBackups method

Future<DescribeBackupsResponse> describeBackups({
  1. Map<String, List<String>>? filters,
  2. int? maxResults,
  3. String? nextToken,
  4. bool? shared,
  5. bool? sortAscending,
})

Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.

May throw CloudHsmAccessDeniedException. May throw CloudHsmInternalFailureException. May throw CloudHsmInvalidRequestException. May throw CloudHsmResourceNotFoundException. May throw CloudHsmServiceException. May throw CloudHsmTagException.

Parameter filters : One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

Parameter maxResults : The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

Parameter nextToken : The NextToken value that you received in the previous response. Use this value to get more backups.

Parameter shared : Describe backups that are shared with you.

Parameter sortAscending : Designates whether or not to sort the return backups by ascending chronological order of generation.

Implementation

Future<DescribeBackupsResponse> describeBackups({
  Map<String, List<String>>? filters,
  int? maxResults,
  String? nextToken,
  bool? shared,
  bool? sortAscending,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    50,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'BaldrApiService.DescribeBackups'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (shared != null) 'Shared': shared,
      if (sortAscending != null) 'SortAscending': sortAscending,
    },
  );

  return DescribeBackupsResponse.fromJson(jsonResponse.body);
}