Skip to content

EC2  >  Operations  >  modify_snapshot_tier

modify_snapshot_tier

Operation

modify_snapshot_tier async

modify_snapshot_tier(input: ModifySnapshotTierInput, plugins: list[Plugin] | None = None) -> ModifySnapshotTierOutput

Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon EBS User Guide.

Parameters:

Name Type Description Default
input ModifySnapshotTierInput

An instance of ModifySnapshotTierInput.

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
ModifySnapshotTierOutput

An instance of ModifySnapshotTierOutput.

Input

ModifySnapshotTierInput dataclass

Bases: _SerdeShape

Dataclass for ModifySnapshotTierInput 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.

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

The name of the storage tier. You must specify archive.

Output

ModifySnapshotTierOutput dataclass

Bases: _SerdeShape

Dataclass for ModifySnapshotTierOutput 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.

tiering_start_time class-attribute instance-attribute
tiering_start_time: datetime | None = ...

The date and time when the archive process was started.