Class UpdateSnapshotCommandProtected

Updates the name of an Amazon FSx for OpenZFS snapshot.

Example

Use a bare-bones client and the command you need to make an API call.

import { FSxClient, UpdateSnapshotCommand } from "@aws-sdk/client-fsx"; // ES Modules import
// const { FSxClient, UpdateSnapshotCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
const client = new FSxClient(config);
const input = { // UpdateSnapshotRequest
  ClientRequestToken: "STRING_VALUE",
  Name: "STRING_VALUE", // required
  SnapshotId: "STRING_VALUE", // required
};
const command = new UpdateSnapshotCommand(input);
const response = await client.send(command);
// { // UpdateSnapshotResponse
//   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",
//         ProgressPercent: Number("int"),
//         RequestTime: new Date("TIMESTAMP"),
//         Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_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",
//           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",
//               ],
//             },
//           },
//           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",
//               ProgressPercent: Number("int"),
//               RequestTime: new Date("TIMESTAMP"),
//               Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_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",
//                 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",
//                     ],
//                   },
//                 },
//                 AdministrativeActions: "<AdministrativeActions>",
//                 OntapConfiguration: { // OntapFileSystemConfiguration
//                   AutomaticBackupRetentionDays: Number("int"),
//                   DailyAutomaticBackupStartTime: "STRING_VALUE",
//                   DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_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" || "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",
//                 },
//               },
//               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",
//                 },
//               },
//               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",
//             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" || "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",
//           },
//         },
//         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",
//           },
//         },
//         TargetSnapshotValues: "<Snapshot>",
//         TotalTransferBytes: Number("long"),
//         RemainingTransferBytes: Number("long"),
//       },
//     ],
//   },
// };

Param

UpdateSnapshotCommandInput

Returns

UpdateSnapshotCommandOutput

See

• UpdateSnapshotCommandInput for command's input shape.
• UpdateSnapshotCommandOutput for command's response shape.
• config for FSxClient's config shape.

Throws

BadRequest (client fault)

A generic error indicating a failure with a client request.

Throws

InternalServerError (server fault)

A generic error indicating a server-side failure.

Throws

SnapshotNotFound (client fault)

No Amazon FSx snapshots were found based on the supplied parameters.

Throws

FSxServiceException

Base exception class for all service exceptions from FSx service.