Skip to content

DynamoDB  >  Operations  >  list_backups

list_backups

Operation

list_backups async 

list_backups(input: ListBackupsInput, plugins: list[Plugin] | None = None) -> ListBackupsOutput

List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. To list these backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a maximum number of entries to be returned in a page.

In the request, start time is inclusive, but end time is exclusive. Note that these boundaries are for the time at which the original backup was requested.

You can call ListBackups a maximum of five times per second.

If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the Amazon Web Services Backup list API.

Parameters:

Name Type Description Default
input ListBackupsInput

An instance of ListBackupsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ListBackupsOutput

An instance of ListBackupsOutput.

Input

ListBackupsInput dataclass

Dataclass for ListBackupsInput structure.

Attributes

backup_type class-attribute instance-attribute 
backup_type: BackupTypeFilter | None = None

The backups from the table specified by BackupType are listed.

Where BackupType can be:

  • USER - On-demand backup created by you. (The default setting if no other backup types are specified.)

  • SYSTEM - On-demand backup automatically created by DynamoDB.

  • ALL - All types of on-demand backups (USER and SYSTEM).

exclusive_start_backup_arn class-attribute instance-attribute 
exclusive_start_backup_arn: str | None = None

LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

limit class-attribute instance-attribute 
limit: int | None = None

Maximum number of backups to return at once.

table_name class-attribute instance-attribute 
table_name: str | None = None

Lists the backups from the table specified in TableName. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

time_range_lower_bound class-attribute instance-attribute 
time_range_lower_bound: datetime | None = None

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

time_range_upper_bound class-attribute instance-attribute 
time_range_upper_bound: datetime | None = None

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

Output

ListBackupsOutput dataclass

Dataclass for ListBackupsOutput structure.

Attributes

backup_summaries class-attribute instance-attribute 
backup_summaries: list[BackupSummary] | None = None

List of BackupSummary objects.

last_evaluated_backup_arn class-attribute instance-attribute 
last_evaluated_backup_arn: str | None = None

The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved.

If LastEvaluatedBackupArn is not empty, this may or may not indicate that there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned.