get_secret Method

Gets a secret's value and information.

Syntax

def get_secret(secret_name: str) -> None: ...

Remarks

This method gets the value and information for the secret specified by SecretName. The VersionId configuration setting can be used to target a specific secret version. The secret's value is returned via the specified local_file or the secret_data property.

Alternatively, the GetDeleted configuration setting can be enabled to get a soft-deleted secret's information (but not its value).

When the information is returned, the class clears the Secret* properties and repopulates them with a single item that contains the secret's information, and repopulates the Tag* properties with the secret's tags. The on_secret_list and on_tag_list events are also fired.