CreateSnapshots
Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance.
You can include all of the volumes currently attached to the instance, or you can exclude the root volume or specific data (non-root) volumes from the multi-volume snapshot set.
You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- CopyTagsFromSource
-
Copies the tags from the specified volume to corresponding snapshot.
Type: String
Valid Values:
volume
Required: No
- Description
-
A description propagated to every snapshot specified by the instance.
Type: String
Required: No
- DryRun
-
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 isUnauthorizedOperation
.Type: Boolean
Required: No
- InstanceSpecification
-
The instance to specify which volumes should be included in the snapshots.
Type: InstanceSpecification object
Required: Yes
- OutpostArn
-
The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
-
To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.
-
To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.
-
To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.
For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon EBS User Guide.
Type: String
Required: No
-
- TagSpecification.N
-
Tags to apply to every snapshot specified by the instance.
Type: Array of TagSpecification objects
Required: No
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- snapshotSet
-
List of snapshots.
Type: Array of SnapshotInfo objects
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: