Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14158359.3 KB

Gets information about backups of AWS CloudHSM clusters.

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.

post/#X-Amz-Target=BaldrApiService.DescribeBackups

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'BaldrApiService.DescribeBackups' required

Request body

NextTokenstring

The <code>NextToken</code> value that you received in the previous response. Use this value to get more backups.

MaxResultsinteger

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a <code>NextToken</code> value.

Filtersobject
<p>One or more filters to limit the items returned in the response.</p> <p>Use the <code>backupIds</code> filter to return only the specified backups. Specify backups by their backup identifier (ID).</p> <p>Use the <code>sourceBackupIds</code> filter to return only the backups created from a source backup. The <code>sourceBackupID</code> of a source backup is returned by the <a>CopyBackupToRegion</a> operation.</p> <p>Use the <code>clusterIds</code> filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).</p> <p>Use the <code>states</code> filter to return only backups that match the specified state.</p> <p>Use the <code>neverExpires</code> filter to return backups filtered by the value in the <code>neverExpires</code> parameter. <code>True</code> returns all backups exempt from the backup retention policy. <code>False</code> returns all backups with a backup retention policy defined at the cluster.</p>
SortAscendingboolean

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

Response

Success

NextTokenstring

An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent <code>DescribeBackups</code> request to get more backups.