create_snapshot¶
Operation¶
async
¶
create_snapshot(input: CreateSnapshotInput, plugins: list[Plugin] | None = None) -> CreateSnapshotOutput
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
The location of the source EBS volume determines where you can create the snapshot.
-
If the source volume is in a Region, you must create the snapshot in the same Region as the volume.
-
If the source volume is in a Local Zone, you can create the snapshot in the same Local Zone or in its parent Amazon Web Services Region.
-
If the source volume is on an Outpost, you can create the snapshot on the same Outpost or in its parent Amazon Web Services Region.
When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However,
snapshots only capture data that has been written to your Amazon EBS
volume at the time the snapshot command is issued; this might exclude
any data that has been cached by any applications or the operating
system. If you can pause any file systems on the volume long enough to
take a snapshot, your snapshot should be complete. However, if you
cannot pause all file writes to the volume, you should unmount the
volume from within the instance, issue the snapshot command, and then
remount the volume to ensure a consistent and complete snapshot. You may
remount and use your volume while the snapshot status is pending.
When you create a snapshot for an EBS volume that serves as a root device, we recommend that you stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateSnapshotInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateSnapshotOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateSnapshotInput structure.
Attributes¶
class-attribute
instance-attribute
¶
description: str | None = ...
A description for the snapshot.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
class-attribute
instance-attribute
¶
location: str | None = ...
Note
Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.
-
To create a local snapshot in the same Local Zone as the source volume, specify
local. -
To create a regional snapshot in the parent Region of the Local Zone, specify
regionalor omit this parameter.
Default value: regional
class-attribute
instance-attribute
¶
outpost_arn: str | None = ...
Note
Only supported for volumes on Outposts. If the source volume is not on an Outpost, omit this parameter.
-
To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume.
-
To create the snapshot in the parent Region of the Outpost, omit this parameter.
For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.
Output¶
dataclass
¶
Bases: _SerdeShape
Describes a snapshot.
Attributes¶
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).
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.
class-attribute
instance-attribute
¶
completion_time: datetime | None = ...
The time stamp when the snapshot was completed.
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.
class-attribute
instance-attribute
¶
description: str | None = ...
The description for the snapshot.
class-attribute
instance-attribute
¶
encrypted: bool | None = ...
Indicates whether the snapshot is encrypted.
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.
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.
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.
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.
class-attribute
instance-attribute
¶
owner_id: str | None = ...
The ID of the Amazon Web Services account that owns the EBS snapshot.
class-attribute
instance-attribute
¶
progress: str | None = ...
The progress of the snapshot, as a percentage.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
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.
class-attribute
instance-attribute
¶
snapshot_id: str | None = ...
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
class-attribute
instance-attribute
¶
start_time: datetime | None = ...
The time stamp when the snapshot was initiated.
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.
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.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = ...
Any tags assigned to the snapshot.
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.