Documentation

Describes a snapshot.

See: newSnapshot smart constructor.

Create a value of Snapshot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataEncryptionKeyId:Snapshot', snapshot_dataEncryptionKeyId - 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.

$sel:kmsKeyId:Snapshot', snapshot_kmsKeyId - The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.

$sel:outpostArn:Snapshot', snapshot_outpostArn - The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

$sel:ownerAlias:Snapshot', snapshot_ownerAlias - 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.

$sel:restoreExpiryTime:Snapshot', snapshot_restoreExpiryTime - Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.

$sel:stateMessage:Snapshot', snapshot_stateMessage - Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (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.

$sel:storageTier:Snapshot', snapshot_storageTier - 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.

$sel:tags:Snapshot', snapshot_tags - Any tags assigned to the snapshot.

$sel:snapshotId:Snapshot', snapshot_snapshotId - The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

$sel:ownerId:Snapshot', snapshot_ownerId - The ID of the Amazon Web Services account that owns the EBS snapshot.

$sel:volumeId:Snapshot', snapshot_volumeId - The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

$sel:volumeSize:Snapshot', snapshot_volumeSize - The size of the volume, in GiB.

$sel:description:Snapshot', snapshot_description - The description for the snapshot.

$sel:startTime:Snapshot', snapshot_startTime - The time stamp when the snapshot was initiated.

$sel:progress:Snapshot', snapshot_progress - The progress of the snapshot, as a percentage.

$sel:state:Snapshot', snapshot_state - The snapshot state.

$sel:encrypted:Snapshot', snapshot_encrypted - Indicates whether the snapshot is encrypted.

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.

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

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

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.

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

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (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.

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.

Any tags assigned to the snapshot.

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

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

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

The size of the volume, in GiB.

The description for the snapshot.

The time stamp when the snapshot was initiated.

The progress of the snapshot, as a percentage.

The snapshot state.

Indicates whether the snapshot is encrypted.