Skip to content

unlock_snapshot

Operation

unlock_snapshot

unlock_snapshot(request: UnlockSnapshotInput | UnlockSnapshotInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UnlockSnapshotInputDict]) -> UnlockSnapshotOutput

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:

Name Type Description Default
request UnlockSnapshotInput | UnlockSnapshotInputDict | 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[UnlockSnapshotInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UnlockSnapshotOutput

An instance of UnlockSnapshotOutput.

unlock_snapshot async

unlock_snapshot(request: UnlockSnapshotInput | UnlockSnapshotInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UnlockSnapshotInputDict]) -> UnlockSnapshotOutput

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:

Name Type Description Default
request UnlockSnapshotInput | UnlockSnapshotInputDict | 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[UnlockSnapshotInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UnlockSnapshotOutput

An instance of UnlockSnapshotOutput.

Input

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

UnlockSnapshotInputDict

Bases: TypedDict

Dictionary form of UnlockSnapshotInput.

Attributes

dry_run instance-attribute
dry_run: bool | 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.

snapshot_id instance-attribute
snapshot_id: Required[str]

The ID of the snapshot to unlock.

UnlockSnapshotInput dataclass

Bases: _SerdeShape

Dataclass for UnlockSnapshotInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | 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.

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

The ID of the snapshot to unlock.

Output

UnlockSnapshotOutput dataclass

Bases: _SerdeShape

Dataclass for UnlockSnapshotOutput structure.

Attributes

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.

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

The ID of the snapshot.