AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.

If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the specified client request token doesn't exist, CreateSnapshot does the following:

By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.

The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateSnapshot and EndCreateSnapshot.

Namespace: Amazon.FSx
Assembly: AWSSDK.FSx.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CreateSnapshotResponse> CreateSnapshotAsync(
         CreateSnapshotRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.FSx.Model.CreateSnapshotRequest

Container for the necessary parameters to execute the CreateSnapshot service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateSnapshot service method, as returned by FSx.

Exceptions

ExceptionCondition
BadRequestException A generic error indicating a failure with a client request.
InternalServerErrorException A generic error indicating a server-side failure.
ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also