Skip to content

Secrets Manager  >  Operations  >  cancel_rotate_secret

cancel_rotate_secret

Operation

cancel_rotate_secret async 

cancel_rotate_secret(input: CancelRotateSecretInput, plugins: list[Plugin] | None = None) -> CancelRotateSecretOutput

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.

Parameters:

Name Type Description Default
input CancelRotateSecretInput

An instance of CancelRotateSecretInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CancelRotateSecretOutput

An instance of CancelRotateSecretOutput.

Input

CancelRotateSecretInput dataclass

Dataclass for CancelRotateSecretInput structure.

Attributes

secret_id class-attribute instance-attribute 
secret_id: str | None = None

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.

Output

CancelRotateSecretOutput dataclass

Dataclass for CancelRotateSecretOutput structure.

Attributes

arn class-attribute instance-attribute 
arn: str | None = None

The ARN of the secret.

name class-attribute instance-attribute 
name: str | None = None

The name of the secret.

version_id class-attribute instance-attribute 
version_id: str | None = None

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.