Skip to content

EC2  >  Structures  >  Snapshot

Snapshot

Structure Class

Snapshot dataclass

Bases: _SerdeShape

Describes a snapshot.

Attributes

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

The Availability Zone or Local Zone of the snapshot. For example, us-west-1a (Availability Zone) or us-west-2-lax-1a (Local Zone).

completion_duration_minutes class-attribute instance-attribute 
completion_duration_minutes: int | None = ...
Note

Only for snapshot copies created with time-based snapshot copy operations.

The completion duration requested for the time-based snapshot copy operation.

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

The time stamp when the snapshot was completed.

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

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

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

The description for the snapshot.

encrypted class-attribute instance-attribute 
encrypted: bool | None = ...

Indicates whether the snapshot is encrypted.

full_snapshot_size_in_bytes class-attribute instance-attribute 
full_snapshot_size_in_bytes: int | None = ...

The full size of the snapshot, in bytes.

Warning

This is not the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created.

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

The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.

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

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

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

The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.

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

The ID of the Amazon Web Services account that owns the EBS snapshot.

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

The progress of the snapshot, as a percentage.

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

Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.

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

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

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

Reserved for future use.

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

The time stamp when the snapshot was initiated.

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

The snapshot state.

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

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper KMS permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.

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

The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.

tags class-attribute instance-attribute 
tags: list[Tag] | None = ...

Any tags assigned to the snapshot.

transfer_type class-attribute instance-attribute 
transfer_type: str | None = ...
Note

Only for snapshot copies.

Indicates whether the snapshot copy was created with a standard or time-based snapshot copy operation. Time-based snapshot copy operations complete within the completion duration specified in the request. Standard snapshot copy operations are completed on a best-effort basis.

  • standard - The snapshot copy was created with a standard snapshot copy operation.

  • time-based - The snapshot copy was created with a time-based snapshot copy operation.

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

The ID of the volume that was used to create the snapshot. Snapshots created by a copy snapshot operation have an arbitrary volume ID that you should not use for any purpose.

volume_size class-attribute instance-attribute 
volume_size: int | None = ...

The size of the volume, in GiB.