Network.AWS.SecretsManager.CancelRotateSecret

Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.

To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.

To successfully start a rotation, the staging label AWSPENDING must be in one of the following states:

• Not be attached to any version at all
• Attached to the same version as the staging label AWSCURRENT

If the staging label AWSPENDING is attached to a different version than the version with AWSCURRENT then the attempt to rotate fails.

Minimum permissions

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

• secretsmanager:CancelRotateSecret

Related operations

• To configure rotation for a secret or to manually trigger a rotation, use RotateSecret .
• To get the rotation configuration details for a secret, use DescribeSecret .
• To list all of the currently available secrets, use ListSecrets .
• To list all of the versions currently associated with a secret, use ListSecretVersionIds .

Creating a Request

cancelRotateSecret

Arguments

:: Text

crsSecretId

-> CancelRotateSecret

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

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

• crsSecretId - Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

data CancelRotateSecret

See: cancelRotateSecret smart constructor.

Instances

Eq CancelRotateSecret

Methods

(==) :: CancelRotateSecret -> CancelRotateSecret -> Bool

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

Data CancelRotateSecret

Methods

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

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

toConstr :: CancelRotateSecret -> Constr

dataTypeOf :: CancelRotateSecret -> DataType

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

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

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

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

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

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

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

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

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

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

Read CancelRotateSecret

Methods

readsPrec :: Int -> ReadS CancelRotateSecret

readList :: ReadS [CancelRotateSecret]

readPrec :: ReadPrec CancelRotateSecret

readListPrec :: ReadPrec [CancelRotateSecret]

Show CancelRotateSecret

Methods

showsPrec :: Int -> CancelRotateSecret -> ShowS

show :: CancelRotateSecret -> String

showList :: [CancelRotateSecret] -> ShowS

Generic CancelRotateSecret

Associated Types

type Rep CancelRotateSecret :: * -> *

Methods

from :: CancelRotateSecret -> Rep CancelRotateSecret x

to :: Rep CancelRotateSecret x -> CancelRotateSecret

Hashable CancelRotateSecret

Methods

hashWithSalt :: Int -> CancelRotateSecret -> Int

hash :: CancelRotateSecret -> Int

ToJSON CancelRotateSecret

Methods

toJSON :: CancelRotateSecret -> Value

toEncoding :: CancelRotateSecret -> Encoding

toJSONList :: [CancelRotateSecret] -> Value

toEncodingList :: [CancelRotateSecret] -> Encoding

NFData CancelRotateSecret

Methods

rnf :: CancelRotateSecret -> ()

AWSRequest CancelRotateSecret

Associated Types

type Rs CancelRotateSecret :: *

Methods

request :: CancelRotateSecret -> Request CancelRotateSecret

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

ToHeaders CancelRotateSecret

Methods

toHeaders :: CancelRotateSecret -> [Header]

ToPath CancelRotateSecret

Methods

toPath :: CancelRotateSecret -> ByteString

ToQuery CancelRotateSecret

Methods

toQuery :: CancelRotateSecret -> QueryString

type Rep CancelRotateSecret

type Rep CancelRotateSecret = D1 * (MetaData "CancelRotateSecret" "Network.AWS.SecretsManager.CancelRotateSecret" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" True) (C1 * (MetaCons "CancelRotateSecret'" PrefixI True) (S1 * (MetaSel (Just Symbol "_crsSecretId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs CancelRotateSecret

type Rs CancelRotateSecret = CancelRotateSecretResponse

Request Lenses

crsSecretId :: Lens' CancelRotateSecret Text

Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Destructuring the Response

cancelRotateSecretResponse

Arguments

:: Int

crsrsResponseStatus

-> CancelRotateSecretResponse

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

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

• crsrsVersionId - The unique identifier of the version of the secret that was created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage value AWSPENDING to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
• crsrsARN - The ARN of the secret for which rotation was canceled.
• crsrsName - The friendly name of the secret for which rotation was canceled.
• crsrsResponseStatus - -- | The response status code.

data CancelRotateSecretResponse

See: cancelRotateSecretResponse smart constructor.

Instances

Eq CancelRotateSecretResponse

Methods

(==) :: CancelRotateSecretResponse -> CancelRotateSecretResponse -> Bool

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

Data CancelRotateSecretResponse

Methods

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

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

toConstr :: CancelRotateSecretResponse -> Constr

dataTypeOf :: CancelRotateSecretResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CancelRotateSecretResponse

Methods

readsPrec :: Int -> ReadS CancelRotateSecretResponse

readList :: ReadS [CancelRotateSecretResponse]

readPrec :: ReadPrec CancelRotateSecretResponse

readListPrec :: ReadPrec [CancelRotateSecretResponse]

Show CancelRotateSecretResponse

Methods

showsPrec :: Int -> CancelRotateSecretResponse -> ShowS

show :: CancelRotateSecretResponse -> String

showList :: [CancelRotateSecretResponse] -> ShowS

Generic CancelRotateSecretResponse

Associated Types

type Rep CancelRotateSecretResponse :: * -> *

Methods

from :: CancelRotateSecretResponse -> Rep CancelRotateSecretResponse x

to :: Rep CancelRotateSecretResponse x -> CancelRotateSecretResponse

NFData CancelRotateSecretResponse

Methods

rnf :: CancelRotateSecretResponse -> ()

type Rep CancelRotateSecretResponse

type Rep CancelRotateSecretResponse = D1 * (MetaData "CancelRotateSecretResponse" "Network.AWS.SecretsManager.CancelRotateSecret" "amazonka-secretsmanager-1.6.0-K7nD2j5oEj0GsgMw0kPUxD" False) (C1 * (MetaCons "CancelRotateSecretResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_crsrsVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_crsrsARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_crsrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_crsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

crsrsVersionId :: Lens' CancelRotateSecretResponse (Maybe Text)

The unique identifier of the version of the secret that was created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage value AWSPENDING to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.

crsrsARN :: Lens' CancelRotateSecretResponse (Maybe Text)

The ARN of the secret for which rotation was canceled.

crsrsName :: Lens' CancelRotateSecretResponse (Maybe Text)

The friendly name of the secret for which rotation was canceled.

crsrsResponseStatus :: Lens' CancelRotateSecretResponse Int

• - | The response status code.