Skip to content

restore_secret

Operation

restore_secret

restore_secret(request: RestoreSecretInput | RestoreSecretInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RestoreSecretInputDict]) -> 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
request RestoreSecretInput | RestoreSecretInputDict | 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[RestoreSecretInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RestoreSecretOutput

An instance of RestoreSecretOutput.

restore_secret async

restore_secret(request: RestoreSecretInput | RestoreSecretInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RestoreSecretInputDict]) -> 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
request RestoreSecretInput | RestoreSecretInputDict | 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[RestoreSecretInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RestoreSecretOutput

An instance of RestoreSecretOutput.

Input

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

RestoreSecretInputDict

Bases: TypedDict

Dictionary form of RestoreSecretInput.

Attributes

secret_id instance-attribute
secret_id: Required[str]

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.

RestoreSecretInput dataclass

Bases: _SerdeShape

Dataclass for RestoreSecretInput structure.

Attributes

secret_id class-attribute instance-attribute
secret_id: str | 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

RestoreSecretOutput dataclass

Bases: _SerdeShape

Dataclass for RestoreSecretOutput structure.

Attributes

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

The ARN of the secret that was restored.

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

The name of the secret that was restored.

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.