Request Parameters Response Elements Errors See Also

DescribeDBClusterAutomatedBackups

Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.

All parameters are optional.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBClusterIdentifier

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

Type: String

Required: No

DbClusterResourceId

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

Type: String

Required: No

Filters.Filter.N

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

Supported filters are the following:

status
- retained - Automated backups for deleted clusters and after backup replication is stopped.
db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs.
db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.

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

Type: Array of Filter objects

Required: No

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.

Type: String

Required: No

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.

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

DBClusterAutomatedBackups.DBClusterAutomatedBackup.N

A list of DBClusterAutomatedBackup backups.

Type: Array of DBClusterAutomatedBackup objects

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DBClusterAutomatedBackupNotFoundFault

No automated backup for this DB cluster was found.

HTTP Status Code: 404