Amazonka.SecretsManager.CancelRotateSecret

Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.

If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. You might need to remove the staging label AWSPENDING from the partially created version. You also need to determine whether to roll back to the previous version of the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To determine which version has a specific staging label, call ListSecretVersionIds. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation works.

To turn on automatic rotation again, call RotateSecret.

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:CancelRotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Creating a Request

data CancelRotateSecret

See: newCancelRotateSecret smart constructor.

Constructors

CancelRotateSecret'

Fields

• secretId :: Text

  The ARN or name of the secret.

  For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Instances

ToJSON CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

toJSON :: CancelRotateSecret -> Value

toEncoding :: CancelRotateSecret -> Encoding

toJSONList :: [CancelRotateSecret] -> Value

toEncodingList :: [CancelRotateSecret] -> Encoding

ToHeaders CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

toHeaders :: CancelRotateSecret -> [Header]

ToPath CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

toPath :: CancelRotateSecret -> ByteString

ToQuery CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

toQuery :: CancelRotateSecret -> QueryString

AWSRequest CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Associated Types

type AWSResponse CancelRotateSecret

Methods

request :: (Service -> Service) -> CancelRotateSecret -> Request CancelRotateSecret

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CancelRotateSecret -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelRotateSecret)))

Generic CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Associated Types

type Rep CancelRotateSecret :: Type -> Type

Methods

from :: CancelRotateSecret -> Rep CancelRotateSecret x

to :: Rep CancelRotateSecret x -> CancelRotateSecret

Read CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

readsPrec :: Int -> ReadS CancelRotateSecret

readList :: ReadS [CancelRotateSecret]

readPrec :: ReadPrec CancelRotateSecret

readListPrec :: ReadPrec [CancelRotateSecret]

Show CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

showsPrec :: Int -> CancelRotateSecret -> ShowS

show :: CancelRotateSecret -> String

showList :: [CancelRotateSecret] -> ShowS

NFData CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

rnf :: CancelRotateSecret -> ()

Eq CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

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

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

Hashable CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

hashWithSalt :: Int -> CancelRotateSecret -> Int

hash :: CancelRotateSecret -> Int

type AWSResponse CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

type AWSResponse CancelRotateSecret = CancelRotateSecretResponse

type Rep CancelRotateSecret

Defined in Amazonka.SecretsManager.CancelRotateSecret

type Rep CancelRotateSecret = D1 ('MetaData "CancelRotateSecret" "Amazonka.SecretsManager.CancelRotateSecret" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "CancelRotateSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelRotateSecret

Arguments

:: Text

$sel:secretId:CancelRotateSecret'

-> CancelRotateSecret

Create a value of CancelRotateSecret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:secretId:CancelRotateSecret', cancelRotateSecret_secretId - The ARN or name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Request Lenses

cancelRotateSecret_secretId :: Lens' CancelRotateSecret Text

The ARN or name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Destructuring the Response

data CancelRotateSecretResponse

See: newCancelRotateSecretResponse smart constructor.

Constructors

CancelRotateSecretResponse'

Fields

• arn :: Maybe Text

  The ARN of the secret.

• name :: Maybe Text

  The name of the secret.

• versionId :: Maybe Text

  The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage value AWSPENDING from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CancelRotateSecretResponse

Defined in Amazonka.SecretsManager.CancelRotateSecret

Associated Types

type Rep CancelRotateSecretResponse :: Type -> Type

Methods

from :: CancelRotateSecretResponse -> Rep CancelRotateSecretResponse x

to :: Rep CancelRotateSecretResponse x -> CancelRotateSecretResponse

Read CancelRotateSecretResponse

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

readsPrec :: Int -> ReadS CancelRotateSecretResponse

readList :: ReadS [CancelRotateSecretResponse]

readPrec :: ReadPrec CancelRotateSecretResponse

readListPrec :: ReadPrec [CancelRotateSecretResponse]

Show CancelRotateSecretResponse

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

showsPrec :: Int -> CancelRotateSecretResponse -> ShowS

show :: CancelRotateSecretResponse -> String

showList :: [CancelRotateSecretResponse] -> ShowS

NFData CancelRotateSecretResponse

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

rnf :: CancelRotateSecretResponse -> ()

Eq CancelRotateSecretResponse

Defined in Amazonka.SecretsManager.CancelRotateSecret

Methods

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

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

type Rep CancelRotateSecretResponse

Defined in Amazonka.SecretsManager.CancelRotateSecret

type Rep CancelRotateSecretResponse = D1 ('MetaData "CancelRotateSecretResponse" "Amazonka.SecretsManager.CancelRotateSecret" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "CancelRotateSecretResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCancelRotateSecretResponse

Arguments

:: Int

$sel:httpStatus:CancelRotateSecretResponse'

-> CancelRotateSecretResponse

Create a value of CancelRotateSecretResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CancelRotateSecretResponse, cancelRotateSecretResponse_arn - The ARN of the secret.

CancelRotateSecretResponse, cancelRotateSecretResponse_name - The name of the secret.

CancelRotateSecretResponse, cancelRotateSecretResponse_versionId - The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage value AWSPENDING from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.

$sel:httpStatus:CancelRotateSecretResponse', cancelRotateSecretResponse_httpStatus - The response's http status code.

Response Lenses

cancelRotateSecretResponse_arn :: Lens' CancelRotateSecretResponse (Maybe Text)

The ARN of the secret.

cancelRotateSecretResponse_name :: Lens' CancelRotateSecretResponse (Maybe Text)

The name of the secret.

cancelRotateSecretResponse_versionId :: Lens' CancelRotateSecretResponse (Maybe Text)

The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage value AWSPENDING from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.

cancelRotateSecretResponse_httpStatus :: Lens' CancelRotateSecretResponse Int

The response's http status code.