Skip to content

cancel_rotate_secret

Operation

cancel_rotate_secret

cancel_rotate_secret(request: CancelRotateSecretInput | CancelRotateSecretInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelRotateSecretInputDict]) -> 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 DescribeSecret. 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
request CancelRotateSecretInput | CancelRotateSecretInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CancelRotateSecretInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CancelRotateSecretOutput

An instance of CancelRotateSecretOutput.

cancel_rotate_secret async

cancel_rotate_secret(request: CancelRotateSecretInput | CancelRotateSecretInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelRotateSecretInputDict]) -> 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 DescribeSecret. 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
request CancelRotateSecretInput | CancelRotateSecretInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CancelRotateSecretInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CancelRotateSecretOutput

An instance of CancelRotateSecretOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CancelRotateSecretInputDict

Bases: TypedDict

Dictionary form of CancelRotateSecretInput.

Attributes

secret_id instance-attribute
secret_id: Required[str]

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.

CancelRotateSecretInput dataclass

Bases: _SerdeShape

Dataclass for CancelRotateSecretInput structure.

Attributes

secret_id class-attribute instance-attribute
secret_id: str | 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

Bases: _SerdeShape

Dataclass for CancelRotateSecretOutput structure.

Attributes

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

The ARN of the secret.

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

The name of the secret.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

version_id class-attribute instance-attribute
version_id: str | 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.