delete_db_snapshot¶
Operation¶
delete_db_snapshot
¶
delete_db_snapshot(request: DeleteDBSnapshotInput | DeleteDBSnapshotInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDBSnapshotInputDict]) -> 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 |
|---|---|---|---|
request
|
DeleteDBSnapshotInput | DeleteDBSnapshotInputDict | 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[DeleteDBSnapshotInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteDBSnapshotOutput
|
An instance of |
delete_db_snapshot
async
¶
delete_db_snapshot(request: DeleteDBSnapshotInput | DeleteDBSnapshotInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDBSnapshotInputDict]) -> 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 |
|---|---|---|---|
request
|
DeleteDBSnapshotInput | DeleteDBSnapshotInputDict | 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[DeleteDBSnapshotInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteDBSnapshotOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
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
¶
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.