Skip to content

Describe Db Snapshots

rds_describe_db_snapshots R Documentation

Returns information about DB snapshots

Description

Returns information about DB snapshots. This API action supports pagination.

Usage

rds_describe_db_snapshots(DBInstanceIdentifier, DBSnapshotIdentifier,
  SnapshotType, Filters, MaxRecords, Marker, IncludeShared, IncludePublic,
  DbiResourceId)

Arguments

DBInstanceIdentifier

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBInstance.

DBSnapshotIdentifier

A specific DB snapshot identifier to describe. 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.

SnapshotType

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 Amazon Web Services account.

  • manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

  • shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

  • public - Return all DB snapshots that have been marked as public.

  • awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

    For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.

    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.

Filters

A filter that specifies one or more DB snapshots to describe.

Supported filters:

  • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

  • db-snapshot-id - Accepts DB snapshot identifiers.

  • dbi-resource-id - Accepts identifiers of source DB instances.

  • snapshot-type - Accepts types of DB snapshots.

  • engine - Accepts names of database engines.

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.

Default: 100

Constraints: Minimum 20, maximum 100.

Marker

An optional pagination token provided by a previous describe_db_snapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

IncludeShared

Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the modify_db_snapshot_attribute API action.

This setting doesn't apply to RDS Custom.

IncludePublic

Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the modify_db_snapshot_attribute API.

This setting doesn't apply to RDS Custom.

DbiResourceId

A specific DB resource ID to describe.

Value

A list with the following syntax: 

list(
  Marker = "string",
  DBSnapshots = list(
    list(
      DBSnapshotIdentifier = "string",
      DBInstanceIdentifier = "string",
      SnapshotCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      Engine = "string",
      AllocatedStorage = 123,
      Status = "string",
      Port = 123,
      AvailabilityZone = "string",
      VpcId = "string",
      InstanceCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      MasterUsername = "string",
      EngineVersion = "string",
      LicenseModel = "string",
      SnapshotType = "string",
      Iops = 123,
      OptionGroupName = "string",
      PercentProgress = 123,
      SourceRegion = "string",
      SourceDBSnapshotIdentifier = "string",
      StorageType = "string",
      TdeCredentialArn = "string",
      Encrypted = TRUE|FALSE,
      KmsKeyId = "string",
      DBSnapshotArn = "string",
      Timezone = "string",
      IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
      ProcessorFeatures = list(
        list(
          Name = "string",
          Value = "string"
        )
      ),
      DbiResourceId = "string",
      TagList = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      OriginalSnapshotCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      SnapshotDatabaseTime = as.POSIXct(
        "2015-01-01"
      ),
      SnapshotTarget = "string",
      StorageThroughput = 123,
      DBSystemId = "string",
      DedicatedLogVolume = TRUE|FALSE,
      MultiTenant = TRUE|FALSE
    )
  )
)

Request syntax

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"
)