Skip to content

describe_db_cluster_snapshots

Operation

describe_db_cluster_snapshots

describe_db_cluster_snapshots(request: DescribeDBClusterSnapshotsInput | DescribeDBClusterSnapshotsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBClusterSnapshotsInputDict]) -> DescribeDBClusterSnapshotsOutput

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

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameters:

Name Type Description Default
request DescribeDBClusterSnapshotsInput | DescribeDBClusterSnapshotsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeDBClusterSnapshotsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeDBClusterSnapshotsOutput

An instance of DescribeDBClusterSnapshotsOutput.

describe_db_cluster_snapshots async

describe_db_cluster_snapshots(request: DescribeDBClusterSnapshotsInput | DescribeDBClusterSnapshotsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBClusterSnapshotsInputDict]) -> DescribeDBClusterSnapshotsOutput

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

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameters:

Name Type Description Default
request DescribeDBClusterSnapshotsInput | DescribeDBClusterSnapshotsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeDBClusterSnapshotsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeDBClusterSnapshotsOutput

An instance of DescribeDBClusterSnapshotsOutput.

Input

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

DescribeDBClusterSnapshotsInputDict

Bases: TypedDict

Dictionary form of DescribeDBClusterSnapshotsInput.

Attributes

db_cluster_identifier instance-attribute
db_cluster_identifier: str | None

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBCluster.
db_cluster_resource_id instance-attribute
db_cluster_resource_id: str | None

A specific DB cluster resource ID to describe.

db_cluster_snapshot_identifier instance-attribute
db_cluster_snapshot_identifier: str | None

A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

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

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

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

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

Supported filters:

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

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

  • snapshot-type - Accepts types of DB cluster 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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

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 cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

marker instance-attribute
marker: str | None

An optional pagination token provided by a previous DescribeDBClusterSnapshots 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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

snapshot_type instance-attribute
snapshot_type: str | None

The type of DB cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

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

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

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

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster 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.

DescribeDBClusterSnapshotsInput dataclass

Bases: _SerdeShape

Attributes

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

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBCluster.
db_cluster_resource_id class-attribute instance-attribute
db_cluster_resource_id: str | None = ...

A specific DB cluster resource ID to describe.

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

A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

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

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

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

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

Supported filters:

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

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

  • snapshot-type - Accepts types of DB cluster 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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

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 cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

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

An optional pagination token provided by a previous DescribeDBClusterSnapshots 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 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 DB cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

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

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

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

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster 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

DescribeDBClusterSnapshotsOutput dataclass

Bases: _SerdeShape

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

Attributes

db_cluster_snapshots class-attribute instance-attribute
db_cluster_snapshots: list[DBClusterSnapshot] | None = ...

Provides a list of DB cluster snapshots for the user.

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

An optional pagination token provided by a previous DescribeDBClusterSnapshots 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.