listRecoveryPointsByBackupVault method

Future<ListRecoveryPointsByBackupVaultOutput> listRecoveryPointsByBackupVault({ required String backupVaultName, String? byBackupPlanId, DateTime? byCreatedAfter, DateTime? byCreatedBefore, String? byResourceArn, String? byResourceType, int? maxResults, String? nextToken, })

Returns detailed information about the recovery points stored in a backup vault.

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

Parameter backupVaultName : The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Parameter byBackupPlanId : Returns only recovery points that match the specified backup plan ID.

Parameter byCreatedAfter : Returns only recovery points that were created after the specified timestamp.

Parameter byCreatedBefore : Returns only recovery points that were created before the specified timestamp.

Parameter byResourceArn : Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

Parameter byResourceType : Returns only recovery points that match the specified resource type.

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<ListRecoveryPointsByBackupVaultOutput>
    listRecoveryPointsByBackupVault({
  required String backupVaultName,
  String? byBackupPlanId,
  DateTime? byCreatedAfter,
  DateTime? byCreatedBefore,
  String? byResourceArn,
  String? byResourceType,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(backupVaultName, 'backupVaultName');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  final $query = <String, List<String>>{
    if (byBackupPlanId != null) 'backupPlanId': [byBackupPlanId],
    if (byCreatedAfter != null)
      'createdAfter': [_s.iso8601ToJson(byCreatedAfter).toString()],
    if (byCreatedBefore != null)
      'createdBefore': [_s.iso8601ToJson(byCreatedBefore).toString()],
    if (byResourceArn != null) 'resourceArn': [byResourceArn],
    if (byResourceType != null) 'resourceType': [byResourceType],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/backup-vaults/${Uri.encodeComponent(backupVaultName)}/recovery-points/',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListRecoveryPointsByBackupVaultOutput.fromJson(response);
}