delete_secret¶
Operation¶
async
¶
delete_secret(input: DeleteSecretInput, plugins: list[Plugin] | None = None) -> DeleteSecretOutput
Deletes a secret and all of its versions. You can specify a recovery
window during which you can restore the secret. The minimum recovery
window is 7 days. The default recovery window is 30 days. Secrets
Manager attaches a DeletionDate stamp to the secret that specifies the
end of the recovery window. At the end of the recovery window, Secrets
Manager deletes the secret permanently.
You can't delete a primary secret that is replicated to other Regions. You must first delete the replicas using RemoveRegionsFromReplication, and then delete the primary secret. When you delete a replica, it is deleted immediately.
You can't directly delete a version of a secret. Instead, you remove all staging labels from the version using UpdateSecretVersionStage. This marks the version as deprecated, and then Secrets Manager can automatically delete the version in the background.
To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during the recovery window. For more information, see Monitor secrets scheduled for deletion.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.
At any time before recovery window ends, you can use RestoreSecret to
remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value. You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteSecret. For more
information, see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeleteSecretInput
|
An instance of |
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 |
|---|---|
DeleteSecretOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for DeleteSecretInput structure.
Attributes¶
class-attribute
instance-attribute
¶
force_delete_without_recovery: bool | None = None
Specifies whether to delete the secret without any recovery window. You
can't use both this parameter and RecoveryWindowInDays in the same
call. If you don't use either, then by default Secrets Manager uses a
30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
If you forcibly delete an already deleted or nonexistent secret, the
operation does not return ResourceNotFoundException.
Warning
Use this parameter with caution. This parameter causes the operation to
skip the normal recovery window before the permanent deletion that
Secrets Manager would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithoutRecovery
parameter, then you have no opportunity to recover the secret. You lose
the secret permanently.
class-attribute
instance-attribute
¶
recovery_window_in_days: int | None = None
The number of days from 7 to 30 that Secrets Manager waits before
permanently deleting the secret. You can't use both this parameter and
ForceDeleteWithoutRecovery in the same call. If you don't use either,
then by default Secrets Manager uses a 30 day recovery window.
class-attribute
instance-attribute
¶
secret_id: str | None = None
The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
Output¶
dataclass
¶
Dataclass for DeleteSecretOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
deletion_date: datetime | None = None
The date and time after which this secret Secrets Manager can
permanently delete this secret, and it can no longer be restored. This
value is the date and time of the delete request plus the number of days
in RecoveryWindowInDays.