Network.AWS.SecretsManager.DeleteSecret

Deletes an entire secret and all of its versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 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.

At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.

You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.

Minimum permissions

To run this command, you must have the following permissions:

• secretsmanager:DeleteSecret

Related operations

• To create a secret, use CreateSecret .
• To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret .

Creating a Request

deleteSecret

Arguments

:: Text

dsSecretId

-> DeleteSecret

Creates a value of DeleteSecret with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dsRecoveryWindowInDays - (Optional) Specifies the number of days that Secrets Manager waits before it can delete the secret. This value can range from 7 to 30 days. The default value is 30.
• dsSecretId - Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

data DeleteSecret

See: deleteSecret smart constructor.

Instances

Eq DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

(==) :: DeleteSecret -> DeleteSecret -> Bool

(/=) :: DeleteSecret -> DeleteSecret -> Bool

Data DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteSecret -> c DeleteSecret

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteSecret

toConstr :: DeleteSecret -> Constr

dataTypeOf :: DeleteSecret -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteSecret)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteSecret)

gmapT :: (forall b. Data b => b -> b) -> DeleteSecret -> DeleteSecret

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteSecret -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteSecret -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteSecret -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteSecret -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteSecret -> m DeleteSecret

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteSecret -> m DeleteSecret

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteSecret -> m DeleteSecret

Read DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

readsPrec :: Int -> ReadS DeleteSecret

readList :: ReadS [DeleteSecret]

readPrec :: ReadPrec DeleteSecret

readListPrec :: ReadPrec [DeleteSecret]

Show DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

showsPrec :: Int -> DeleteSecret -> ShowS

show :: DeleteSecret -> String

showList :: [DeleteSecret] -> ShowS

Generic DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Associated Types

type Rep DeleteSecret :: Type -> Type

Methods

from :: DeleteSecret -> Rep DeleteSecret x

to :: Rep DeleteSecret x -> DeleteSecret

Hashable DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

hashWithSalt :: Int -> DeleteSecret -> Int

hash :: DeleteSecret -> Int

ToJSON DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

toJSON :: DeleteSecret -> Value

toEncoding :: DeleteSecret -> Encoding

toJSONList :: [DeleteSecret] -> Value

toEncodingList :: [DeleteSecret] -> Encoding

AWSRequest DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Associated Types

type Rs DeleteSecret :: Type

Methods

request :: DeleteSecret -> Request DeleteSecret

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DeleteSecret -> ClientResponse -> m (Response DeleteSecret)

ToHeaders DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

toHeaders :: DeleteSecret -> [Header]

ToPath DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

toPath :: DeleteSecret -> ByteString

ToQuery DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

toQuery :: DeleteSecret -> QueryString

NFData DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

rnf :: DeleteSecret -> ()

type Rep DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

type Rep DeleteSecret = D1 (MetaData "DeleteSecret" "Network.AWS.SecretsManager.DeleteSecret" "amazonka-secretsmanager-1.6.1-6zeL5AAjwvS5hEyIAnn7A2" False) (C1 (MetaCons "DeleteSecret'" PrefixI True) (S1 (MetaSel (Just "_dsRecoveryWindowInDays") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_dsSecretId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs DeleteSecret

Defined in Network.AWS.SecretsManager.DeleteSecret

type Rs DeleteSecret = DeleteSecretResponse

Request Lenses

dsRecoveryWindowInDays :: Lens' DeleteSecret (Maybe Integer)

(Optional) Specifies the number of days that Secrets Manager waits before it can delete the secret. This value can range from 7 to 30 days. The default value is 30.

dsSecretId :: Lens' DeleteSecret Text

Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Destructuring the Response

deleteSecretResponse

Arguments

:: Int

dsrsResponseStatus

-> DeleteSecretResponse

Creates a value of DeleteSecretResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dsrsARN - The ARN of the secret that is now scheduled for deletion.
• dsrsName - The friendly name of the secret that is now scheduled for deletion.
• dsrsDeletionDate - The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays .
• dsrsResponseStatus - -- | The response status code.

data DeleteSecretResponse

See: deleteSecretResponse smart constructor.

Instances

Eq DeleteSecretResponse

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

(==) :: DeleteSecretResponse -> DeleteSecretResponse -> Bool

(/=) :: DeleteSecretResponse -> DeleteSecretResponse -> Bool

Data DeleteSecretResponse

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteSecretResponse -> c DeleteSecretResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteSecretResponse

toConstr :: DeleteSecretResponse -> Constr

dataTypeOf :: DeleteSecretResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteSecretResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteSecretResponse)

gmapT :: (forall b. Data b => b -> b) -> DeleteSecretResponse -> DeleteSecretResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteSecretResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteSecretResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteSecretResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteSecretResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteSecretResponse -> m DeleteSecretResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteSecretResponse -> m DeleteSecretResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteSecretResponse -> m DeleteSecretResponse

Read DeleteSecretResponse

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

readsPrec :: Int -> ReadS DeleteSecretResponse

readList :: ReadS [DeleteSecretResponse]

readPrec :: ReadPrec DeleteSecretResponse

readListPrec :: ReadPrec [DeleteSecretResponse]

Show DeleteSecretResponse

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

showsPrec :: Int -> DeleteSecretResponse -> ShowS

show :: DeleteSecretResponse -> String

showList :: [DeleteSecretResponse] -> ShowS

Generic DeleteSecretResponse

Defined in Network.AWS.SecretsManager.DeleteSecret

Associated Types

type Rep DeleteSecretResponse :: Type -> Type

Methods

from :: DeleteSecretResponse -> Rep DeleteSecretResponse x

to :: Rep DeleteSecretResponse x -> DeleteSecretResponse

NFData DeleteSecretResponse

Defined in Network.AWS.SecretsManager.DeleteSecret

Methods

rnf :: DeleteSecretResponse -> ()

type Rep DeleteSecretResponse

Defined in Network.AWS.SecretsManager.DeleteSecret

type Rep DeleteSecretResponse = D1 (MetaData "DeleteSecretResponse" "Network.AWS.SecretsManager.DeleteSecret" "amazonka-secretsmanager-1.6.1-6zeL5AAjwvS5hEyIAnn7A2" False) (C1 (MetaCons "DeleteSecretResponse'" PrefixI True) ((S1 (MetaSel (Just "_dsrsARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dsrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_dsrsDeletionDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_dsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dsrsARN :: Lens' DeleteSecretResponse (Maybe Text)

The ARN of the secret that is now scheduled for deletion.

dsrsName :: Lens' DeleteSecretResponse (Maybe Text)

The friendly name of the secret that is now scheduled for deletion.

dsrsDeletionDate :: Lens' DeleteSecretResponse (Maybe UTCTime)

The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays .

dsrsResponseStatus :: Lens' DeleteSecretResponse Int

• - | The response status code.