Skip to content
AWS for Query.Farm

aws.rds.describe_db_snapshots

Example SQL Queries

SELECT * FROM
aws.rds.describe_db_snapshots;

Description

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

Table Definition

Column NameColumn Data Type
db_instance_identifier Input Column

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

VARCHAR
db_snapshot_identifier Input Column

Specifies the identifier for the DB snapshot.

VARCHAR
dbi_resource_id Input Column

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

VARCHAR
filters Input Column

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.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case-sensitive.

filters[].values[]
include_public Input Column

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 ModifyDBSnapshotAttribute API.

This setting doesn't apply to RDS Custom.

BOOLEAN
include_shared Input Column

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 ModifyDBSnapshotAttribute API action.

This setting doesn't apply to RDS Custom.

BOOLEAN
snapshot_type Input Column

Provides the type of the DB snapshot.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
allocated_storage

Specifies the allocated storage size in gibibytes (GiB).

BIGINT
availability_zone

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

VARCHAR
db_snapshot_arn

The Amazon Resource Name (ARN) for the DB snapshot.

VARCHAR
db_system_id

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

VARCHAR
dedicated_log_volume

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

BOOLEAN
encrypted

Indicates whether the DB snapshot is encrypted.

BOOLEAN
engine

Specifies the name of the database engine.

VARCHAR
engine_version

Specifies the version of the database engine.

VARCHAR
iam_database_authentication_enabled

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

BOOLEAN
instance_create_time

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

TIMESTAMP_S
iops

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

BIGINT
kms_key_id

If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

VARCHAR
license_model

License model information for the restored DB instance.

VARCHAR
master_username

Provides the master username for the DB snapshot.

VARCHAR
multi_tenant

Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

BOOLEAN
option_group_name

Provides the option group name for the DB snapshot.

VARCHAR
original_snapshot_create_time

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

TIMESTAMP_S
percent_progress

The percentage of the estimated data that has been transferred.

BIGINT
port

Specifies the port that the database engine was listening on at the time of the snapshot.

BIGINT
processor_features

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

STRUCT(
    "name" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
processor_features[]
Show child fields
processor_features[].name

The name of the processor feature. Valid names are coreCount and threadsPerCore.

processor_features[].value

The value of a processor feature.

snapshot_create_time

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

TIMESTAMP_S
snapshot_database_time

The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

TIMESTAMP_S
snapshot_target

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

VARCHAR
source_db_snapshot_identifier

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

VARCHAR
source_region

The Amazon Web Services Region that the DB snapshot was created in or copied from.

VARCHAR
status

Specifies the status of this DB snapshot.

VARCHAR
storage_throughput

Specifies the storage throughput for the DB snapshot.

BIGINT
storage_type

Specifies the storage type associated with DB snapshot.

VARCHAR
tag_list

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide. 

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
tag_list[]
Show child fields
tag_list[].key

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

tag_list[].value

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

tde_credential_arn

The ARN from the key store with which to associate the instance for TDE encryption.

VARCHAR
timezone

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

VARCHAR
vpc_id

Provides the VPC ID associated with the DB snapshot.

VARCHAR