Skip to content

unlock_snapshot

unlock_snapshot(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    snapshot_id: Optional[SnapshotId] = None,
    dry_run: Optional[Boolean] = None,
) -> UnlockSnapshotResult

Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode but still in the cooling-off period. You can't unlock a snapshot that is locked in compliance mode after the cooling-off period has expired.

Parameters:

  • snapshot_id (Optional[SnapshotId], default: None ) –

    The ID of the snapshot to unlock.

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def unlock_snapshot(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    snapshot_id: Optional["capo_ec2.types.snapshot_id.SnapshotId"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.unlock_snapshot_result.UnlockSnapshotResult":
    """<p>Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode but still in the cooling-off period. You can't unlock a snapshot that is locked in compliance mode after the cooling-off period has expired.</p>

    Args:
        snapshot_id: <p>The ID of the snapshot to unlock.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.unlock_snapshot_request.UnlockSnapshotRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.unlock_snapshot_result.UnlockSnapshotResult"
    ]:
        import capo_ec2._operations.amazon_ec2.unlock_snapshot

        output, http_response = (
            capo_ec2._operations.amazon_ec2.unlock_snapshot.unlock_snapshot(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UnlockSnapshot")
    )
    input_: capo_ec2.types.unlock_snapshot_request.UnlockSnapshotRequest = {}
    if snapshot_id is not None:
        input_["snapshot_id"] = snapshot_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output