Skip to content

RDS  >  Operations  >  delete_db_snapshot

delete_db_snapshot

Operation

delete_db_snapshot async 

delete_db_snapshot(input: DeleteDBSnapshotInput, plugins: list[Plugin] | None = None) -> DeleteDBSnapshotOutput

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

Note

The DB snapshot must be in the available state to be deleted.

Parameters:

Name Type Description Default
input DeleteDBSnapshotInput

An instance of DeleteDBSnapshotInput.

 required
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
DeleteDBSnapshotOutput

An instance of DeleteDBSnapshotOutput.

Input

DeleteDBSnapshotInput dataclass

Bases: _SerdeShape

Attributes

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

The DB snapshot identifier.

Constraints: Must be the name of an existing DB snapshot in the available state.

Output

DeleteDBSnapshotOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDBSnapshotOutput structure.

Attributes

db_snapshot class-attribute instance-attribute 
db_snapshot: DBSnapshot | None = ...

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the DescribeDBSnapshots action.

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.