Skip to main content

snapshots

List of snapshots by region (requires aws provider to be installed)

Overview

Namesnapshots
TypeResource
DescriptionList of snapshots by region (requires `aws` provider to be installed)
Idawscc.ec2.snapshots

Fields

NameDatatypeDescription
descriptionstringThe description for the snapshot.
data_encryption_key_idstringThe data encryption key identifier for the snapshot.
encryptedbooleanIndicates whether the snapshot is encrypted.
kms_key_idstringThe 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.
outpost_arnstring
owner_aliasstringThe Amazon Web Services owner alias.
owner_idstring
progressstringThe progress of the snapshot, as a percentage.
restore_expiry_timestringOnly for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
snapshot_idstringThe ID of the snapshot. Each snapshot receives a unique identifier when it is created.
start_timestringThe time stamp when the snapshot was initiated.
statusstringThe snapshot state.
status_messagestringEncrypted 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.
storage_tierstringThe storage tier in which the snapshot is stored.
tag_setarray
volume_idstringThe ID of the volume that was used to create the snapshot.
volume_sizeintegerThe size of the volume, in GiB.
regionstring
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
description,
data_encryption_key_id,
encrypted,
kms_key_id,
outpost_arn,
owner_alias,
owner_id,
progress,
restore_expiry_time,
snapshot_id,
start_time,
status,
status_message,
storage_tier,
tag_set,
volume_id,
volume_size,
region
FROM awscc.ec2.snapshots
WHERE region = '<region>';