Module Values.CancelRotateSecretResponseSource

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.

Sourcetype nonrec t = {
  1. aRN : SecretARNType.t option;
    (*

    The ARN of the secret.

    *)
  2. name : SecretNameType.t option;
    (*

    The name of the secret.

    *)
  3. versionId : SecretVersionIdType.t option;
    (*

    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.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServiceError of InternalServiceError.t
  2. | `InvalidParameterException of InvalidParameterException.t
  3. | `InvalidRequestException of InvalidRequestException.t
  4. | `ResourceNotFoundException of ResourceNotFoundException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?aRN:??? -> ?name:??? -> ?versionId:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServiceError of InternalServiceError.t | `InvalidParameterException of InvalidParameterException.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServiceError of InternalServiceError.t | `InvalidParameterException of InvalidParameterException.t | `InvalidRequestException of InvalidRequestException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `String of SecretARNType.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t