Skip to content

DescribeDBClusterSnapshots

Source: src/AWS/DocDB/DescribeDBClusterSnapshots.ts

Runtime binding for the DescribeDBClusterSnapshots operation (IAM action rds:DescribeDBClusterSnapshots — DocumentDB shares the RDS control plane).

Lists the account’s DocumentDB cluster snapshots (optionally filtered by cluster or snapshot identifier) with status and creation time embedded — pairs with CreateDBClusterSnapshot/DeleteDBClusterSnapshot for backup automation. Provide the implementation with Effect.provide(AWS.DocDB.DescribeDBClusterSnapshotsHttp).

const describeSnapshots = yield* DocDB.DescribeDBClusterSnapshots();
const page = yield* describeSnapshots({
DBClusterSnapshotIdentifier: "nightly-2026-07-15",
});
const status = page.DBClusterSnapshots?.[0]?.Status;