Skip to content

DescribeBackupsRequest

Source code in docs_src/capo_fsx/types/describe_backups_request.py 
14
15
16
17
18
19
20
21
22
class DescribeBackupsRequest(TypedDict, closed=True):
    backup_ids: NotRequired["capo_fsx.types.backup_ids.BackupIds"]
    """<p>The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a <code>BackupNotFound</code> error occurs.</p>"""
    filters: NotRequired["capo_fsx.types.filters.Filters"]
    """<p>The filters structure. The supported names are <code>file-system-id</code>, <code>backup-type</code>, <code>file-system-type</code>, and <code>volume-id</code>.</p>"""
    max_results: NotRequired["capo_fsx.types.max_results.MaxResults"]
    """<p>Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</p>"""
    next_token: NotRequired["capo_fsx.types.next_token.NextToken"]
    """<p>An opaque pagination token returned from a previous <code>DescribeBackups</code> operation. If a token is present, the operation continues the list from where the returning call left off.</p>"""

backup_ids instance-attribute 

backup_ids: NotRequired[BackupIds]

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

filters instance-attribute 

filters: NotRequired[Filters]

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

next_token instance-attribute 

next_token: NotRequired[NextToken]

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.