Returns information about DB snapshots. This API action supports pagination.
rds_describe_db_snapshots(DBInstanceIdentifier, DBSnapshotIdentifier,
SnapshotType, Filters, MaxRecords, Marker, IncludeShared, IncludePublic,
DbiResourceId)The ID of the DB instance to retrieve the list of DB snapshots for. This
parameter can't be used in conjunction with DBSnapshotIdentifier.
This parameter is not case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
A specific DB snapshot identifier to describe. This parameter can't be
used in conjunction with DBInstanceIdentifier. This value is stored as
a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically
taken by Amazon RDS for my AWS account.
manual - Return all DB snapshots that have been taken by my AWS
account.
shared - Return all manual DB snapshots that have been shared to
my AWS account.
public - Return all DB snapshots that have been marked as public.
awsbackup - Return the DB snapshots managed by the AWS Backup
service.
For information about AWS Backup, see the AWS Backup DeveloperGuide.
The awsbackup type does not apply to Aurora.
If you don't specify a SnapshotType value, then both automated and
manual snapshots are returned. Shared and public DB snapshots are not
included in the returned results by default. You can include shared
snapshots with these results by enabling the IncludeShared parameter.
You can include public snapshots with these results by enabling the
IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for
SnapshotType values of manual or automated. The IncludePublic
parameter doesn't apply when SnapshotType is set to shared. The
IncludeShared parameter doesn't apply when SnapshotType is set to
public.
This parameter is not currently supported.
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 the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
An optional pagination token provided by a previous
DescribeDBSnapshots request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB snapshot
from another AWS account by using the ModifyDBSnapshotAttribute API
action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
A specific DB resource ID to describe.
svc$describe_db_snapshots(
DBInstanceIdentifier = "string",
DBSnapshotIdentifier = "string",
SnapshotType = "string",
Filters = list(
list(
Name = "string",
Values = list(
"string"
)
)
),
MaxRecords = 123,
Marker = "string",
IncludeShared = TRUE|FALSE,
IncludePublic = TRUE|FALSE,
DbiResourceId = "string"
)