Skip to content

RDS  >  Operations  >  describe_db_snapshots

describe_db_snapshots

Operation

describe_db_snapshots async

describe_db_snapshots(request: DescribeDBSnapshotsInput | DescribeDBSnapshotsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBSnapshotsOutput
describe_db_snapshots(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBSnapshotsInputDict]) -> DescribeDBSnapshotsOutput

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

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeDBSnapshotsOutput

An instance of DescribeDBSnapshotsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeDBSnapshotsInput dataclass

Bases: _SerdeShape

Attributes
db_instance_identifier class-attribute instance-attribute
db_instance_identifier: str | None = ...

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.
db_snapshot_identifier class-attribute instance-attribute
db_snapshot_identifier: str | None = ...

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.

dbi_resource_id class-attribute instance-attribute
dbi_resource_id: str | None = ...

A specific DB resource ID to describe.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

include_public class-attribute instance-attribute
include_public: bool | None = ...

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.

include_shared class-attribute instance-attribute
include_shared: bool | None = ...

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.

marker class-attribute instance-attribute
marker: str | None = ...

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.

max_records class-attribute instance-attribute
max_records: int | None = ...

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.

snapshot_type class-attribute instance-attribute
snapshot_type: str | None = ...

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.

Dictionaries

DescribeDBSnapshotsInputDict

Bases: TypedDict

Dictionary form of DescribeDBSnapshotsInput.

Attributes
db_instance_identifier instance-attribute
db_instance_identifier: str | None

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.
db_snapshot_identifier instance-attribute
db_snapshot_identifier: str | None

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.

dbi_resource_id instance-attribute
dbi_resource_id: str | None

A specific DB resource ID to describe.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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.

include_public instance-attribute
include_public: bool | None

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.

include_shared instance-attribute
include_shared: bool | None

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.

marker instance-attribute
marker: str | None

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.

max_records instance-attribute
max_records: int | None

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.

snapshot_type instance-attribute
snapshot_type: str | None

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.

Output

DescribeDBSnapshotsOutput dataclass

Bases: _SerdeShape

Contains the result of a successful invocation of the DescribeDBSnapshots action.

Attributes

db_snapshots class-attribute instance-attribute
db_snapshots: list[DBSnapshot] | None = ...

A list of DBSnapshot instances.

marker class-attribute instance-attribute
marker: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.