restore_secret¶
Operation¶
async
¶
restore_secret(input: RestoreSecretInput, plugins: list[Plugin] | None = None) -> RestoreSecretOutput
Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. You can access a secret again after it has been restored.
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:RestoreSecret. For more
information, see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RestoreSecretInput
|
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 |
|---|---|
RestoreSecretOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for RestoreSecretInput structure.
Attributes¶
class-attribute
instance-attribute
¶
secret_id: str | None = None
The ARN or name of the secret to restore.
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 RestoreSecretOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
arn: str | None = None
The ARN of the secret that was restored.
class-attribute
instance-attribute
¶
name: str | None = None
The name of the secret that was restored.
class-attribute
instance-attribute
¶
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)
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.