- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateSnapshotCommand
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 operation, which returns the snapshot state along with other information.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { FSxClient, CreateSnapshotCommand } from "@aws-sdk/client-fsx"; // ES Modules import
// const { FSxClient, CreateSnapshotCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
const client = new FSxClient(config);
const input = { // CreateSnapshotRequest
ClientRequestToken: "STRING_VALUE",
Name: "STRING_VALUE", // required
VolumeId: "STRING_VALUE", // required
Tags: [ // Tags
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
};
const command = new CreateSnapshotCommand(input);
const response = await client.send(command);
// { // CreateSnapshotResponse
// Snapshot: { // Snapshot
// ResourceARN: "STRING_VALUE",
// SnapshotId: "STRING_VALUE",
// Name: "STRING_VALUE",
// VolumeId: "STRING_VALUE",
// CreationTime: new Date("TIMESTAMP"),
// Lifecycle: "PENDING" || "CREATING" || "DELETING" || "AVAILABLE",
// LifecycleTransitionReason: { // LifecycleTransitionReason
// Message: "STRING_VALUE",
// },
// Tags: [ // Tags
// { // Tag
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// ],
// AdministrativeActions: [ // AdministrativeActions
// { // AdministrativeAction
// AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION" || "MISCONFIGURED_STATE_RECOVERY" || "VOLUME_UPDATE_WITH_SNAPSHOT" || "VOLUME_INITIALIZE_WITH_SNAPSHOT" || "DOWNLOAD_DATA_FROM_BACKUP",
// ProgressPercent: Number("int"),
// RequestTime: new Date("TIMESTAMP"),
// Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING" || "OPTIMIZING",
// TargetFileSystemValues: { // FileSystem
// OwnerId: "STRING_VALUE",
// CreationTime: new Date("TIMESTAMP"),
// FileSystemId: "STRING_VALUE",
// FileSystemType: "WINDOWS" || "LUSTRE" || "ONTAP" || "OPENZFS",
// Lifecycle: "AVAILABLE" || "CREATING" || "FAILED" || "DELETING" || "MISCONFIGURED" || "UPDATING" || "MISCONFIGURED_UNAVAILABLE",
// FailureDetails: { // FileSystemFailureDetails
// Message: "STRING_VALUE",
// },
// StorageCapacity: Number("int"),
// StorageType: "SSD" || "HDD" || "INTELLIGENT_TIERING",
// VpcId: "STRING_VALUE",
// SubnetIds: [ // SubnetIds
// "STRING_VALUE",
// ],
// NetworkInterfaceIds: [ // NetworkInterfaceIds
// "STRING_VALUE",
// ],
// DNSName: "STRING_VALUE",
// KmsKeyId: "STRING_VALUE",
// ResourceARN: "STRING_VALUE",
// Tags: [
// {
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// ],
// WindowsConfiguration: { // WindowsFileSystemConfiguration
// ActiveDirectoryId: "STRING_VALUE",
// SelfManagedActiveDirectoryConfiguration: { // SelfManagedActiveDirectoryAttributes
// DomainName: "STRING_VALUE",
// OrganizationalUnitDistinguishedName: "STRING_VALUE",
// FileSystemAdministratorsGroup: "STRING_VALUE",
// UserName: "STRING_VALUE",
// DnsIps: [ // DnsIps
// "STRING_VALUE",
// ],
// },
// DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2",
// RemoteAdministrationEndpoint: "STRING_VALUE",
// PreferredSubnetId: "STRING_VALUE",
// PreferredFileServerIp: "STRING_VALUE",
// ThroughputCapacity: Number("int"),
// MaintenanceOperationsInProgress: [ // FileSystemMaintenanceOperations
// "PATCHING" || "BACKING_UP",
// ],
// WeeklyMaintenanceStartTime: "STRING_VALUE",
// DailyAutomaticBackupStartTime: "STRING_VALUE",
// AutomaticBackupRetentionDays: Number("int"),
// CopyTagsToBackups: true || false,
// Aliases: [ // Aliases
// { // Alias
// Name: "STRING_VALUE",
// Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED",
// },
// ],
// AuditLogConfiguration: { // WindowsAuditLogConfiguration
// FileAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
// FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
// AuditLogDestination: "STRING_VALUE",
// },
// DiskIopsConfiguration: { // DiskIopsConfiguration
// Mode: "AUTOMATIC" || "USER_PROVISIONED",
// Iops: Number("long"),
// },
// },
// LustreConfiguration: { // LustreFileSystemConfiguration
// WeeklyMaintenanceStartTime: "STRING_VALUE",
// DataRepositoryConfiguration: { // DataRepositoryConfiguration
// Lifecycle: "CREATING" || "AVAILABLE" || "MISCONFIGURED" || "UPDATING" || "DELETING" || "FAILED",
// ImportPath: "STRING_VALUE",
// ExportPath: "STRING_VALUE",
// ImportedFileChunkSize: Number("int"),
// AutoImportPolicy: "NONE" || "NEW" || "NEW_CHANGED" || "NEW_CHANGED_DELETED",
// FailureDetails: { // DataRepositoryFailureDetails
// Message: "STRING_VALUE",
// },
// },
// DeploymentType: "SCRATCH_1" || "SCRATCH_2" || "PERSISTENT_1" || "PERSISTENT_2",
// PerUnitStorageThroughput: Number("int"),
// MountName: "STRING_VALUE",
// DailyAutomaticBackupStartTime: "STRING_VALUE",
// AutomaticBackupRetentionDays: Number("int"),
// CopyTagsToBackups: true || false,
// DriveCacheType: "NONE" || "READ",
// DataCompressionType: "NONE" || "LZ4",
// LogConfiguration: { // LustreLogConfiguration
// Level: "DISABLED" || "WARN_ONLY" || "ERROR_ONLY" || "WARN_ERROR", // required
// Destination: "STRING_VALUE",
// },
// RootSquashConfiguration: { // LustreRootSquashConfiguration
// RootSquash: "STRING_VALUE",
// NoSquashNids: [ // LustreNoSquashNids
// "STRING_VALUE",
// ],
// },
// MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
// Iops: Number("int"),
// Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
// },
// EfaEnabled: true || false,
// },
// AdministrativeActions: [
// {
// AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION" || "MISCONFIGURED_STATE_RECOVERY" || "VOLUME_UPDATE_WITH_SNAPSHOT" || "VOLUME_INITIALIZE_WITH_SNAPSHOT" || "DOWNLOAD_DATA_FROM_BACKUP",
// ProgressPercent: Number("int"),
// RequestTime: new Date("TIMESTAMP"),
// Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING" || "OPTIMIZING",
// TargetFileSystemValues: {
// OwnerId: "STRING_VALUE",
// CreationTime: new Date("TIMESTAMP"),
// FileSystemId: "STRING_VALUE",
// FileSystemType: "WINDOWS" || "LUSTRE" || "ONTAP" || "OPENZFS",
// Lifecycle: "AVAILABLE" || "CREATING" || "FAILED" || "DELETING" || "MISCONFIGURED" || "UPDATING" || "MISCONFIGURED_UNAVAILABLE",
// FailureDetails: {
// Message: "STRING_VALUE",
// },
// StorageCapacity: Number("int"),
// StorageType: "SSD" || "HDD" || "INTELLIGENT_TIERING",
// VpcId: "STRING_VALUE",
// SubnetIds: [
// "STRING_VALUE",
// ],
// NetworkInterfaceIds: [
// "STRING_VALUE",
// ],
// DNSName: "STRING_VALUE",
// KmsKeyId: "STRING_VALUE",
// ResourceARN: "STRING_VALUE",
// Tags: "<Tags>",
// WindowsConfiguration: {
// ActiveDirectoryId: "STRING_VALUE",
// SelfManagedActiveDirectoryConfiguration: {
// DomainName: "STRING_VALUE",
// OrganizationalUnitDistinguishedName: "STRING_VALUE",
// FileSystemAdministratorsGroup: "STRING_VALUE",
// UserName: "STRING_VALUE",
// DnsIps: [
// "STRING_VALUE",
// ],
// },
// DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2",
// RemoteAdministrationEndpoint: "STRING_VALUE",
// PreferredSubnetId: "STRING_VALUE",
// PreferredFileServerIp: "STRING_VALUE",
// ThroughputCapacity: Number("int"),
// MaintenanceOperationsInProgress: [
// "PATCHING" || "BACKING_UP",
// ],
// WeeklyMaintenanceStartTime: "STRING_VALUE",
// DailyAutomaticBackupStartTime: "STRING_VALUE",
// AutomaticBackupRetentionDays: Number("int"),
// CopyTagsToBackups: true || false,
// Aliases: [
// {
// Name: "STRING_VALUE",
// Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED",
// },
// ],
// AuditLogConfiguration: {
// FileAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
// FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
// AuditLogDestination: "STRING_VALUE",
// },
// DiskIopsConfiguration: {
// Mode: "AUTOMATIC" || "USER_PROVISIONED",
// Iops: Number("long"),
// },
// },
// LustreConfiguration: {
// WeeklyMaintenanceStartTime: "STRING_VALUE",
// DataRepositoryConfiguration: {
// Lifecycle: "CREATING" || "AVAILABLE" || "MISCONFIGURED" || "UPDATING" || "DELETING" || "FAILED",
// ImportPath: "STRING_VALUE",
// ExportPath: "STRING_VALUE",
// ImportedFileChunkSize: Number("int"),
// AutoImportPolicy: "NONE" || "NEW" || "NEW_CHANGED" || "NEW_CHANGED_DELETED",
// FailureDetails: {
// Message: "STRING_VALUE",
// },
// },
// DeploymentType: "SCRATCH_1" || "SCRATCH_2" || "PERSISTENT_1" || "PERSISTENT_2",
// PerUnitStorageThroughput: Number("int"),
// MountName: "STRING_VALUE",
// DailyAutomaticBackupStartTime: "STRING_VALUE",
// AutomaticBackupRetentionDays: Number("int"),
// CopyTagsToBackups: true || false,
// DriveCacheType: "NONE" || "READ",
// DataCompressionType: "NONE" || "LZ4",
// LogConfiguration: {
// Level: "DISABLED" || "WARN_ONLY" || "ERROR_ONLY" || "WARN_ERROR", // required
// Destination: "STRING_VALUE",
// },
// RootSquashConfiguration: {
// RootSquash: "STRING_VALUE",
// NoSquashNids: [
// "STRING_VALUE",
// ],
// },
// MetadataConfiguration: {
// Iops: Number("int"),
// Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
// },
// EfaEnabled: true || false,
// },
// AdministrativeActions: "<AdministrativeActions>",
// OntapConfiguration: { // OntapFileSystemConfiguration
// AutomaticBackupRetentionDays: Number("int"),
// DailyAutomaticBackupStartTime: "STRING_VALUE",
// DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_2",
// EndpointIpAddressRange: "STRING_VALUE",
// Endpoints: { // FileSystemEndpoints
// Intercluster: { // FileSystemEndpoint
// DNSName: "STRING_VALUE",
// IpAddresses: [ // OntapEndpointIpAddresses
// "STRING_VALUE",
// ],
// },
// Management: {
// DNSName: "STRING_VALUE",
// IpAddresses: [
// "STRING_VALUE",
// ],
// },
// },
// DiskIopsConfiguration: {
// Mode: "AUTOMATIC" || "USER_PROVISIONED",
// Iops: Number("long"),
// },
// PreferredSubnetId: "STRING_VALUE",
// RouteTableIds: [ // RouteTableIds
// "STRING_VALUE",
// ],
// ThroughputCapacity: Number("int"),
// WeeklyMaintenanceStartTime: "STRING_VALUE",
// FsxAdminPassword: "STRING_VALUE",
// HAPairs: Number("int"),
// ThroughputCapacityPerHAPair: Number("int"),
// },
// FileSystemTypeVersion: "STRING_VALUE",
// OpenZFSConfiguration: { // OpenZFSFileSystemConfiguration
// AutomaticBackupRetentionDays: Number("int"),
// CopyTagsToBackups: true || false,
// CopyTagsToVolumes: true || false,
// DailyAutomaticBackupStartTime: "STRING_VALUE",
// DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "SINGLE_AZ_HA_1" || "SINGLE_AZ_HA_2" || "MULTI_AZ_1",
// ThroughputCapacity: Number("int"),
// WeeklyMaintenanceStartTime: "STRING_VALUE",
// DiskIopsConfiguration: {
// Mode: "AUTOMATIC" || "USER_PROVISIONED",
// Iops: Number("long"),
// },
// RootVolumeId: "STRING_VALUE",
// PreferredSubnetId: "STRING_VALUE",
// EndpointIpAddressRange: "STRING_VALUE",
// RouteTableIds: [
// "STRING_VALUE",
// ],
// EndpointIpAddress: "STRING_VALUE",
// ReadCacheConfiguration: { // OpenZFSReadCacheConfiguration
// SizingMode: "NO_CACHE" || "USER_PROVISIONED" || "PROPORTIONAL_TO_THROUGHPUT_CAPACITY",
// SizeGiB: Number("int"),
// },
// },
// },
// FailureDetails: { // AdministrativeActionFailureDetails
// Message: "STRING_VALUE",
// },
// TargetVolumeValues: { // Volume
// CreationTime: new Date("TIMESTAMP"),
// FileSystemId: "STRING_VALUE",
// Lifecycle: "CREATING" || "CREATED" || "DELETING" || "FAILED" || "MISCONFIGURED" || "PENDING" || "AVAILABLE",
// Name: "STRING_VALUE",
// OntapConfiguration: { // OntapVolumeConfiguration
// FlexCacheEndpointType: "NONE" || "ORIGIN" || "CACHE",
// JunctionPath: "STRING_VALUE",
// SecurityStyle: "UNIX" || "NTFS" || "MIXED",
// SizeInMegabytes: Number("int"),
// StorageEfficiencyEnabled: true || false,
// StorageVirtualMachineId: "STRING_VALUE",
// StorageVirtualMachineRoot: true || false,
// TieringPolicy: { // TieringPolicy
// CoolingPeriod: Number("int"),
// Name: "SNAPSHOT_ONLY" || "AUTO" || "ALL" || "NONE",
// },
// UUID: "STRING_VALUE",
// OntapVolumeType: "RW" || "DP" || "LS",
// SnapshotPolicy: "STRING_VALUE",
// CopyTagsToBackups: true || false,
// SnaplockConfiguration: { // SnaplockConfiguration
// AuditLogVolume: true || false,
// AutocommitPeriod: { // AutocommitPeriod
// Type: "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "NONE", // required
// Value: Number("int"),
// },
// PrivilegedDelete: "DISABLED" || "ENABLED" || "PERMANENTLY_DISABLED",
// RetentionPeriod: { // SnaplockRetentionPeriod
// DefaultRetention: { // RetentionPeriod
// Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
// Value: Number("int"),
// },
// MinimumRetention: {
// Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
// Value: Number("int"),
// },
// MaximumRetention: {
// Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
// Value: Number("int"),
// },
// },
// SnaplockType: "COMPLIANCE" || "ENTERPRISE",
// VolumeAppendModeEnabled: true || false,
// },
// VolumeStyle: "FLEXVOL" || "FLEXGROUP",
// AggregateConfiguration: { // AggregateConfiguration
// Aggregates: [ // Aggregates
// "STRING_VALUE",
// ],
// TotalConstituents: Number("int"),
// },
// SizeInBytes: Number("long"),
// },
// ResourceARN: "STRING_VALUE",
// Tags: "<Tags>",
// VolumeId: "STRING_VALUE",
// VolumeType: "ONTAP" || "OPENZFS",
// LifecycleTransitionReason: {
// Message: "STRING_VALUE",
// },
// AdministrativeActions: "<AdministrativeActions>",
// OpenZFSConfiguration: { // OpenZFSVolumeConfiguration
// ParentVolumeId: "STRING_VALUE",
// VolumePath: "STRING_VALUE",
// StorageCapacityReservationGiB: Number("int"),
// StorageCapacityQuotaGiB: Number("int"),
// RecordSizeKiB: Number("int"),
// DataCompressionType: "NONE" || "ZSTD" || "LZ4",
// CopyTagsToSnapshots: true || false,
// OriginSnapshot: { // OpenZFSOriginSnapshotConfiguration
// SnapshotARN: "STRING_VALUE",
// CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY",
// },
// ReadOnly: true || false,
// NfsExports: [ // OpenZFSNfsExports
// { // OpenZFSNfsExport
// ClientConfigurations: [ // OpenZFSClientConfigurations // required
// { // OpenZFSClientConfiguration
// Clients: "STRING_VALUE", // required
// Options: [ // OpenZFSNfsExportOptions // required
// "STRING_VALUE",
// ],
// },
// ],
// },
// ],
// UserAndGroupQuotas: [ // OpenZFSUserAndGroupQuotas
// { // OpenZFSUserOrGroupQuota
// Type: "USER" || "GROUP", // required
// Id: Number("int"), // required
// StorageCapacityQuotaGiB: Number("int"), // required
// },
// ],
// RestoreToSnapshot: "STRING_VALUE",
// DeleteIntermediateSnaphots: true || false,
// DeleteClonedVolumes: true || false,
// DeleteIntermediateData: true || false,
// SourceSnapshotARN: "STRING_VALUE",
// DestinationSnapshot: "STRING_VALUE",
// CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY",
// },
// },
// TargetSnapshotValues: {
// ResourceARN: "STRING_VALUE",
// SnapshotId: "STRING_VALUE",
// Name: "STRING_VALUE",
// VolumeId: "STRING_VALUE",
// CreationTime: new Date("TIMESTAMP"),
// Lifecycle: "PENDING" || "CREATING" || "DELETING" || "AVAILABLE",
// LifecycleTransitionReason: {
// Message: "STRING_VALUE",
// },
// Tags: "<Tags>",
// AdministrativeActions: "<AdministrativeActions>",
// },
// TotalTransferBytes: Number("long"),
// RemainingTransferBytes: Number("long"),
// },
// ],
// OntapConfiguration: {
// AutomaticBackupRetentionDays: Number("int"),
// DailyAutomaticBackupStartTime: "STRING_VALUE",
// DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_2",
// EndpointIpAddressRange: "STRING_VALUE",
// Endpoints: {
// Intercluster: {
// DNSName: "STRING_VALUE",
// IpAddresses: [
// "STRING_VALUE",
// ],
// },
// Management: {
// DNSName: "STRING_VALUE",
// IpAddresses: [
// "STRING_VALUE",
// ],
// },
// },
// DiskIopsConfiguration: {
// Mode: "AUTOMATIC" || "USER_PROVISIONED",
// Iops: Number("long"),
// },
// PreferredSubnetId: "STRING_VALUE",
// RouteTableIds: [
// "STRING_VALUE",
// ],
// ThroughputCapacity: Number("int"),
// WeeklyMaintenanceStartTime: "STRING_VALUE",
// FsxAdminPassword: "STRING_VALUE",
// HAPairs: Number("int"),
// ThroughputCapacityPerHAPair: Number("int"),
// },
// FileSystemTypeVersion: "STRING_VALUE",
// OpenZFSConfiguration: {
// AutomaticBackupRetentionDays: Number("int"),
// CopyTagsToBackups: true || false,
// CopyTagsToVolumes: true || false,
// DailyAutomaticBackupStartTime: "STRING_VALUE",
// DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "SINGLE_AZ_HA_1" || "SINGLE_AZ_HA_2" || "MULTI_AZ_1",
// ThroughputCapacity: Number("int"),
// WeeklyMaintenanceStartTime: "STRING_VALUE",
// DiskIopsConfiguration: "<DiskIopsConfiguration>",
// RootVolumeId: "STRING_VALUE",
// PreferredSubnetId: "STRING_VALUE",
// EndpointIpAddressRange: "STRING_VALUE",
// RouteTableIds: [
// "STRING_VALUE",
// ],
// EndpointIpAddress: "STRING_VALUE",
// ReadCacheConfiguration: {
// SizingMode: "NO_CACHE" || "USER_PROVISIONED" || "PROPORTIONAL_TO_THROUGHPUT_CAPACITY",
// SizeGiB: Number("int"),
// },
// },
// },
// FailureDetails: {
// Message: "STRING_VALUE",
// },
// TargetVolumeValues: {
// CreationTime: new Date("TIMESTAMP"),
// FileSystemId: "STRING_VALUE",
// Lifecycle: "CREATING" || "CREATED" || "DELETING" || "FAILED" || "MISCONFIGURED" || "PENDING" || "AVAILABLE",
// Name: "STRING_VALUE",
// OntapConfiguration: {
// FlexCacheEndpointType: "NONE" || "ORIGIN" || "CACHE",
// JunctionPath: "STRING_VALUE",
// SecurityStyle: "UNIX" || "NTFS" || "MIXED",
// SizeInMegabytes: Number("int"),
// StorageEfficiencyEnabled: true || false,
// StorageVirtualMachineId: "STRING_VALUE",
// StorageVirtualMachineRoot: true || false,
// TieringPolicy: {
// CoolingPeriod: Number("int"),
// Name: "SNAPSHOT_ONLY" || "AUTO" || "ALL" || "NONE",
// },
// UUID: "STRING_VALUE",
// OntapVolumeType: "RW" || "DP" || "LS",
// SnapshotPolicy: "STRING_VALUE",
// CopyTagsToBackups: true || false,
// SnaplockConfiguration: {
// AuditLogVolume: true || false,
// AutocommitPeriod: {
// Type: "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "NONE", // required
// Value: Number("int"),
// },
// PrivilegedDelete: "DISABLED" || "ENABLED" || "PERMANENTLY_DISABLED",
// RetentionPeriod: {
// DefaultRetention: {
// Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
// Value: Number("int"),
// },
// MinimumRetention: {
// Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required
// Value: Number("int"),
// },
// MaximumRetention: "<RetentionPeriod>", // required
// },
// SnaplockType: "COMPLIANCE" || "ENTERPRISE",
// VolumeAppendModeEnabled: true || false,
// },
// VolumeStyle: "FLEXVOL" || "FLEXGROUP",
// AggregateConfiguration: {
// Aggregates: [
// "STRING_VALUE",
// ],
// TotalConstituents: Number("int"),
// },
// SizeInBytes: Number("long"),
// },
// ResourceARN: "STRING_VALUE",
// Tags: "<Tags>",
// VolumeId: "STRING_VALUE",
// VolumeType: "ONTAP" || "OPENZFS",
// LifecycleTransitionReason: "<LifecycleTransitionReason>",
// AdministrativeActions: "<AdministrativeActions>",
// OpenZFSConfiguration: {
// ParentVolumeId: "STRING_VALUE",
// VolumePath: "STRING_VALUE",
// StorageCapacityReservationGiB: Number("int"),
// StorageCapacityQuotaGiB: Number("int"),
// RecordSizeKiB: Number("int"),
// DataCompressionType: "NONE" || "ZSTD" || "LZ4",
// CopyTagsToSnapshots: true || false,
// OriginSnapshot: {
// SnapshotARN: "STRING_VALUE",
// CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY",
// },
// ReadOnly: true || false,
// NfsExports: [
// {
// ClientConfigurations: [ // required
// {
// Clients: "STRING_VALUE", // required
// Options: [ // required
// "STRING_VALUE",
// ],
// },
// ],
// },
// ],
// UserAndGroupQuotas: [
// {
// Type: "USER" || "GROUP", // required
// Id: Number("int"), // required
// StorageCapacityQuotaGiB: Number("int"), // required
// },
// ],
// RestoreToSnapshot: "STRING_VALUE",
// DeleteIntermediateSnaphots: true || false,
// DeleteClonedVolumes: true || false,
// DeleteIntermediateData: true || false,
// SourceSnapshotARN: "STRING_VALUE",
// DestinationSnapshot: "STRING_VALUE",
// CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY",
// },
// },
// TargetSnapshotValues: "<Snapshot>",
// TotalTransferBytes: Number("long"),
// RemainingTransferBytes: Number("long"),
// },
// ],
// },
// };
CreateSnapshotCommand Input
See CreateSnapshotCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
NameRequired | string | undefined | The name of the snapshot. |
VolumeIdRequired | string | undefined | The ID of the volume that you are taking a snapshot of. |
ClientRequestToken | string | undefined | (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 Command Line Interface (CLI) or an Amazon Web Services SDK. |
Tags | Tag[] | undefined | A list of |
CreateSnapshotCommand Output
See CreateSnapshotCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Snapshot | Snapshot | undefined | A description of the snapshot. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequest | client | A generic error indicating a failure with a client request. |
| InternalServerError | server | A generic error indicating a server-side failure. |
| ServiceLimitExceeded | client | An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support. |
| VolumeNotFound | client | No Amazon FSx volumes were found based upon the supplied parameters. |
| FSxServiceException | Base exception class for all service exceptions from FSx service. |