Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

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 the DescribeSnapshots API operation.

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 full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

Type: String

Required: No

ownerAlias

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

Type: String

Required: No

ownerId

The AWS account ID of the EBS snapshot owner.

Type: String

Required: No

progress

The progress of the snapshot, as a percentage.

Type: String

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

Required: No

statusMessage

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

Type: String

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 AWS SDKs, see the following:

On this page: