import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DeleteSecretRequest, DeleteSecretResponse } from "../models/models_0"; import type { SecretsManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecretsManagerClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DeleteSecretCommand}. */ export interface DeleteSecretCommandInput extends DeleteSecretRequest { } /** * @public * * The output of {@link DeleteSecretCommand}. */ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __MetadataBearer { } declare const DeleteSecretCommand_base: { new (input: DeleteSecretCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: DeleteSecretCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SecretsManagerClient, DeleteSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import * // const { SecretsManagerClient, DeleteSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import * // import type { SecretsManagerClientConfig } from "@aws-sdk/client-secrets-manager"; * const config = {}; // type is SecretsManagerClientConfig * const client = new SecretsManagerClient(config); * const input = { // DeleteSecretRequest * SecretId: "STRING_VALUE", // required * RecoveryWindowInDays: Number("long"), * ForceDeleteWithoutRecovery: true || false, * }; * const command = new DeleteSecretCommand(input); * const response = await client.send(command); * // { // DeleteSecretResponse * // ARN: "STRING_VALUE", * // Name: "STRING_VALUE", * // DeletionDate: new Date("TIMESTAMP"), * // }; * * ``` * * @param DeleteSecretCommandInput - {@link DeleteSecretCommandInput} * @returns {@link DeleteSecretCommandOutput} * @see {@link DeleteSecretCommandInput} for command's `input` shape. * @see {@link DeleteSecretCommandOutput} for command's `response` shape. * @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape. * * @throws {@link InternalServiceError} (server fault) *

An error occurred on the server side.

* * @throws {@link InvalidParameterException} (client fault) *

The parameter name or value is invalid.

* * @throws {@link InvalidRequestException} (client fault) *

A parameter value is not valid for the current state of the * resource.

*

Possible causes:

* * * @throws {@link ResourceNotFoundException} (client fault) *

Secrets Manager can't find the resource that you asked for.

* * @throws {@link SecretsManagerServiceException} *

Base exception class for all service exceptions from SecretsManager service.

* * * @public */ export declare class DeleteSecretCommand extends DeleteSecretCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeleteSecretRequest; output: DeleteSecretResponse; }; sdk: { input: DeleteSecretCommandInput; output: DeleteSecretCommandOutput; }; }; }