Snapshot - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Snapshot

Describes a snapshot.

Contents

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.

Type: String

Required: No

description

The description for the snapshot.

Type: String

Required: No

encrypted

Indicates whether the snapshot is encrypted.

Type: Boolean

Required: No

kmsKeyId

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

Type: String

Required: No

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.

Type: String

Required: No

ownerAlias

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

Type: String

Required: No

ownerId

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

Type: String

Required: No

progress

The progress of the snapshot, as a percentage.

Type: String

Required: No

restoreExpiryTime

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

Type: Timestamp

Required: No

snapshotId

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

Type: String

Required: No

startTime

The time stamp when the snapshot was initiated.

Type: Timestamp

Required: No

status

The snapshot state.

Type: String

Valid Values: pending | completed | error | recoverable | recovering

Required: No

statusMessage

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

Type: String

Required: No

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.

Type: String

Valid Values: archive | standard

Required: No

tagSet

Any tags assigned to the snapshot.

Type: Array of Tag objects

Required: No

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.

Type: String

Required: No

volumeSize

The size of the volume, in GiB.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: