# CreateSnapshot
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:
+ Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of `CREATING`.
+ Returns the description of the snapshot.
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](https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html) operation, which returns the snapshot state along with other information.
## Request Syntax
```
{
"ClientRequestToken": "string",
"Name": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VolumeId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ClientRequestToken](#API_CreateSnapshot_RequestSyntax) **
(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[A-za-z0-9_.-]{0,63}$`
Required: No
** [Name](#API_CreateSnapshot_RequestSyntax) **
The name of the snapshot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 203.
Pattern: `^[a-zA-Z0-9_:.-]{1,203}$`
Required: Yes
** [Tags](#API_CreateSnapshot_RequestSyntax) **
A list of `Tag` values, with a maximum of 50 elements.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
** [VolumeId](#API_CreateSnapshot_RequestSyntax) **
The ID of the volume that you are taking a snapshot of.
Type: String
Length Constraints: Fixed length of 23.
Pattern: `^(fsvol-[0-9a-f]{17,})$`
Required: Yes
## Response Syntax
```
{
"Snapshot": {
"AdministrativeActions": [
{
"AdministrativeActionType": "string",
"FailureDetails": {
"Message": "string"
},
"Message": "string",
"ProgressPercent": number,
"RemainingTransferBytes": number,
"RequestTime": number,
"Status": "string",
"TargetFileSystemValues": {
"AdministrativeActions": [
"AdministrativeAction"
],
"CreationTime": number,
"DNSName": "string",
"FailureDetails": {
"Message": "string"
},
"FileSystemId": "string",
"FileSystemType": "string",
"FileSystemTypeVersion": "string",
"KmsKeyId": "string",
"Lifecycle": "string",
"LustreConfiguration": {
"AutomaticBackupRetentionDays": number,
"CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string",
"DataCompressionType": "string",
"DataReadCacheConfiguration": {
"SizeGiB": number,
"SizingMode": "string"
},
"DataRepositoryConfiguration": {
"AutoImportPolicy": "string",
"ExportPath": "string",
"FailureDetails": {
"Message": "string"
},
"ImportedFileChunkSize": number,
"ImportPath": "string",
"Lifecycle": "string"
},
"DeploymentType": "string",
"DriveCacheType": "string",
"EfaEnabled": boolean,
"LogConfiguration": {
"Destination": "string",
"Level": "string"
},
"MetadataConfiguration": {
"Iops": number,
"Mode": "string"
},
"MountName": "string",
"PerUnitStorageThroughput": number,
"RootSquashConfiguration": {
"NoSquashNids": [ "string" ],
"RootSquash": "string"
},
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
},
"NetworkInterfaceIds": [ "string" ],
"NetworkType": "string",
"OntapConfiguration": {
"AutomaticBackupRetentionDays": number,
"DailyAutomaticBackupStartTime": "string",
"DeploymentType": "string",
"DiskIopsConfiguration": {
"Iops": number,
"Mode": "string"
},
"EndpointIpAddressRange": "string",
"EndpointIpv6AddressRange": "string",
"Endpoints": {
"Intercluster": {
"DNSName": "string",
"IpAddresses": [ "string" ],
"Ipv6Addresses": [ "string" ]
},
"Management": {
"DNSName": "string",
"IpAddresses": [ "string" ],
"Ipv6Addresses": [ "string" ]
}
},
"FsxAdminPassword": "string",
"HAPairs": number,
"PreferredSubnetId": "string",
"RouteTableIds": [ "string" ],
"ThroughputCapacity": number,
"ThroughputCapacityPerHAPair": number,
"WeeklyMaintenanceStartTime": "string"
},
"OpenZFSConfiguration": {
"AutomaticBackupRetentionDays": number,
"CopyTagsToBackups": boolean,
"CopyTagsToVolumes": boolean,
"DailyAutomaticBackupStartTime": "string",
"DeploymentType": "string",
"DiskIopsConfiguration": {
"Iops": number,
"Mode": "string"
},
"EndpointIpAddress": "string",
"EndpointIpAddressRange": "string",
"EndpointIpv6Address": "string",
"EndpointIpv6AddressRange": "string",
"PreferredSubnetId": "string",
"ReadCacheConfiguration": {
"SizeGiB": number,
"SizingMode": "string"
},
"RootVolumeId": "string",
"RouteTableIds": [ "string" ],
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
},
"OwnerId": "string",
"ResourceARN": "string",
"StorageCapacity": number,
"StorageType": "string",
"SubnetIds": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcId": "string",
"WindowsConfiguration": {
"ActiveDirectoryId": "string",
"Aliases": [
{
"Lifecycle": "string",
"Name": "string"
}
],
"AuditLogConfiguration": {
"AuditLogDestination": "string",
"FileAccessAuditLogLevel": "string",
"FileShareAccessAuditLogLevel": "string"
},
"AutomaticBackupRetentionDays": number,
"CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string",
"DeploymentType": "string",
"DiskIopsConfiguration": {
"Iops": number,
"Mode": "string"
},
"FsrmConfiguration": {
"EventLogDestination": "string",
"FsrmServiceEnabled": boolean
},
"MaintenanceOperationsInProgress": [ "string" ],
"PreferredFileServerIp": "string",
"PreferredFileServerIpv6": "string",
"PreferredSubnetId": "string",
"RemoteAdministrationEndpoint": "string",
"SelfManagedActiveDirectoryConfiguration": {
"DnsIps": [ "string" ],
"DomainJoinServiceAccountSecret": "string",
"DomainName": "string",
"FileSystemAdministratorsGroup": "string",
"OrganizationalUnitDistinguishedName": "string",
"UserName": "string"
},
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
}
},
"TargetSnapshotValues": "Snapshot",
"TargetVolumeValues": {
"AdministrativeActions": [
"AdministrativeAction"
],
"CreationTime": number,
"FileSystemId": "string",
"Lifecycle": "string",
"LifecycleTransitionReason": {
"Message": "string"
},
"Name": "string",
"OntapConfiguration": {
"AggregateConfiguration": {
"Aggregates": [ "string" ],
"TotalConstituents": number
},
"CopyTagsToBackups": boolean,
"FlexCacheEndpointType": "string",
"JunctionPath": "string",
"OntapVolumeType": "string",
"SecurityStyle": "string",
"SizeInBytes": number,
"SizeInMegabytes": number,
"SnaplockConfiguration": {
"AuditLogVolume": boolean,
"AutocommitPeriod": {
"Type": "string",
"Value": number
},
"PrivilegedDelete": "string",
"RetentionPeriod": {
"DefaultRetention": {
"Type": "string",
"Value": number
},
"MaximumRetention": {
"Type": "string",
"Value": number
},
"MinimumRetention": {
"Type": "string",
"Value": number
}
},
"SnaplockType": "string",
"VolumeAppendModeEnabled": boolean
},
"SnapshotPolicy": "string",
"StorageEfficiencyEnabled": boolean,
"StorageVirtualMachineId": "string",
"StorageVirtualMachineRoot": boolean,
"TieringPolicy": {
"CoolingPeriod": number,
"Name": "string"
},
"UUID": "string",
"VolumeStyle": "string"
},
"OpenZFSConfiguration": {
"CopyStrategy": "string",
"CopyTagsToSnapshots": boolean,
"DataCompressionType": "string",
"DeleteClonedVolumes": boolean,
"DeleteIntermediateData": boolean,
"DeleteIntermediateSnaphots": boolean,
"DestinationSnapshot": "string",
"NfsExports": [
{
"ClientConfigurations": [
{
"Clients": "string",
"Options": [ "string" ]
}
]
}
],
"OriginSnapshot": {
"CopyStrategy": "string",
"SnapshotARN": "string"
},
"ParentVolumeId": "string",
"ReadOnly": boolean,
"RecordSizeKiB": number,
"RestoreToSnapshot": "string",
"SourceSnapshotARN": "string",
"StorageCapacityQuotaGiB": number,
"StorageCapacityReservationGiB": number,
"UserAndGroupQuotas": [
{
"Id": number,
"StorageCapacityQuotaGiB": number,
"Type": "string"
}
],
"VolumePath": "string"
},
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VolumeId": "string",
"VolumeType": "string"
},
"TotalTransferBytes": number
}
],
"CreationTime": number,
"Lifecycle": "string",
"LifecycleTransitionReason": {
"Message": "string"
},
"Name": "string",
"ResourceARN": "string",
"SnapshotId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VolumeId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Snapshot](#API_CreateSnapshot_ResponseSyntax) **
A description of the snapshot.
Type: [Snapshot](API_Snapshot.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** BadRequest **
A generic error indicating a failure with a client request.
** Message **
A detailed error message.
HTTP Status Code: 400
** InternalServerError **
A generic error indicating a server-side failure.
** Message **
A detailed error message.
HTTP Status Code: 500
** ServiceLimitExceeded **
An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.
** Limit **
Enumeration of the service limit that was exceeded.
** Message **
A detailed error message.
HTTP Status Code: 400
** VolumeNotFound **
No Amazon FSx volumes were found based upon the supplied parameters.
** Message **
A detailed error message.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/fsx-2018-03-01/CreateSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/fsx-2018-03-01/CreateSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/fsx-2018-03-01/CreateSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/fsx-2018-03-01/CreateSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/fsx-2018-03-01/CreateSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/fsx-2018-03-01/CreateSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/fsx-2018-03-01/CreateSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/fsx-2018-03-01/CreateSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/fsx-2018-03-01/CreateSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/fsx-2018-03-01/CreateSnapshot)