describeDBInstanceAutomatedBackups method

Future<DBInstanceAutomatedBackupMessage> describeDBInstanceAutomatedBackups({ String? dBInstanceAutomatedBackupsArn, String? dBInstanceIdentifier, String? dbiResourceId, List<Filter>? filters, String? marker, int? maxRecords, })

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

All parameters are optional.

May throw DBInstanceAutomatedBackupNotFoundFault.

Parameter dBInstanceAutomatedBackupsArn : The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

Parameter dBInstanceIdentifier : (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.

Parameter dbiResourceId : The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

Parameter filters : A filter that specifies which resources to return based on status.

Supported filters are the following:

• status
  • active - automated backups for current instances
  • retained - automated backups for deleted instances and after backup replication is stopped
  • creating - automated backups that are waiting for the first automated snapshot to be available
• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.
• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

Parameter marker : The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Parameter maxRecords : The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Implementation

Future<DBInstanceAutomatedBackupMessage> describeDBInstanceAutomatedBackups({
  String? dBInstanceAutomatedBackupsArn,
  String? dBInstanceIdentifier,
  String? dbiResourceId,
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
}) async {
  final $request = <String, dynamic>{};
  dBInstanceAutomatedBackupsArn
      ?.also((arg) => $request['DBInstanceAutomatedBackupsArn'] = arg);
  dBInstanceIdentifier?.also((arg) => $request['DBInstanceIdentifier'] = arg);
  dbiResourceId?.also((arg) => $request['DbiResourceId'] = arg);
  filters?.also((arg) => $request['Filters'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeDBInstanceAutomatedBackups',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeDBInstanceAutomatedBackupsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeDBInstanceAutomatedBackupsResult',
  );
  return DBInstanceAutomatedBackupMessage.fromXml($result);
}