@aws-sdk/client-fsx 3.325.0 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/dist-types/commands/AssociateFileSystemAliasesCommand.d.ts +11 -0
  2. package/dist-types/commands/CancelDataRepositoryTaskCommand.d.ts +7 -0
  3. package/dist-types/commands/CopyBackupCommand.d.ts +489 -0
  4. package/dist-types/commands/CreateBackupCommand.d.ts +489 -0
  5. package/dist-types/commands/CreateDataRepositoryAssociationCommand.d.ts +53 -0
  6. package/dist-types/commands/CreateDataRepositoryTaskCommand.d.ts +42 -0
  7. package/dist-types/commands/CreateFileCacheCommand.d.ts +50 -0
  8. package/dist-types/commands/CreateFileSystemCommand.d.ts +466 -0
  9. package/dist-types/commands/CreateFileSystemFromBackupCommand.d.ts +466 -0
  10. package/dist-types/commands/CreateSnapshotCommand.d.ts +464 -0
  11. package/dist-types/commands/CreateStorageVirtualMachineCommand.d.ts +63 -0
  12. package/dist-types/commands/CreateVolumeCommand.d.ts +464 -0
  13. package/dist-types/commands/CreateVolumeFromBackupCommand.d.ts +464 -0
  14. package/dist-types/commands/DeleteBackupCommand.d.ts +7 -0
  15. package/dist-types/commands/DeleteDataRepositoryAssociationCommand.d.ts +8 -0
  16. package/dist-types/commands/DeleteFileCacheCommand.d.ts +7 -0
  17. package/dist-types/commands/DeleteFileSystemCommand.d.ts +34 -0
  18. package/dist-types/commands/DeleteSnapshotCommand.d.ts +7 -0
  19. package/dist-types/commands/DeleteStorageVirtualMachineCommand.d.ts +7 -0
  20. package/dist-types/commands/DeleteVolumeCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeBackupsCommand.d.ts +492 -0
  22. package/dist-types/commands/DescribeDataRepositoryAssociationsCommand.d.ts +56 -0
  23. package/dist-types/commands/DescribeDataRepositoryTasksCommand.d.ts +45 -0
  24. package/dist-types/commands/DescribeFileCachesCommand.d.ts +46 -0
  25. package/dist-types/commands/DescribeFileSystemAliasesCommand.d.ts +12 -0
  26. package/dist-types/commands/DescribeFileSystemsCommand.d.ts +469 -0
  27. package/dist-types/commands/DescribeSnapshotsCommand.d.ts +467 -0
  28. package/dist-types/commands/DescribeStorageVirtualMachinesCommand.d.ts +66 -0
  29. package/dist-types/commands/DescribeVolumesCommand.d.ts +467 -0
  30. package/dist-types/commands/DisassociateFileSystemAliasesCommand.d.ts +11 -0
  31. package/dist-types/commands/ListTagsForResourceCommand.d.ts +12 -0
  32. package/dist-types/commands/ReleaseFileSystemNfsV3LocksCommand.d.ts +466 -0
  33. package/dist-types/commands/RestoreVolumeFromSnapshotCommand.d.ts +483 -0
  34. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  35. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  36. package/dist-types/commands/UpdateDataRepositoryAssociationCommand.d.ts +53 -0
  37. package/dist-types/commands/UpdateFileCacheCommand.d.ts +43 -0
  38. package/dist-types/commands/UpdateFileSystemCommand.d.ts +466 -0
  39. package/dist-types/commands/UpdateSnapshotCommand.d.ts +464 -0
  40. package/dist-types/commands/UpdateStorageVirtualMachineCommand.d.ts +63 -0
  41. package/dist-types/commands/UpdateVolumeCommand.d.ts +464 -0
  42. package/package.json +3 -3
package/dist-types/commands/AssociateFileSystemAliasesCommand.d.ts CHANGED
@@ -45,6 +45,15 @@ export interface AssociateFileSystemAliasesCommandOutput extends AssociateFileSy
45
45
  * };
46
46
  * const command = new AssociateFileSystemAliasesCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // AssociateFileSystemAliasesResponse
49
+ * // Aliases: [ // Aliases
50
+ * // { // Alias
51
+ * // Name: "STRING_VALUE",
52
+ * // Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED",
53
+ * // },
54
+ * // ],
55
+ * // };
56
+ *
48
57
  * ```
49
58
  *
50
59
  * @param AssociateFileSystemAliasesCommandInput - {@link AssociateFileSystemAliasesCommandInput}
@@ -62,6 +71,8 @@ export interface AssociateFileSystemAliasesCommandOutput extends AssociateFileSy
62
71
  * @throws {@link InternalServerError} (server fault)
63
72
  * <p>A generic error indicating a server-side failure.</p>
64
73
  *
74
+ * @throws {@link FSxServiceException}
75
+ * <p>Base exception class for all service exceptions from FSx service.</p>
65
76
  *
66
77
  */
67
78
  export declare class AssociateFileSystemAliasesCommand extends $Command<AssociateFileSystemAliasesCommandInput, AssociateFileSystemAliasesCommandOutput, FSxClientResolvedConfig> {
package/dist-types/commands/CancelDataRepositoryTaskCommand.d.ts CHANGED
@@ -43,6 +43,11 @@ export interface CancelDataRepositoryTaskCommandOutput extends CancelDataReposit
43
43
  * };
44
44
  * const command = new CancelDataRepositoryTaskCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // CancelDataRepositoryTaskResponse
47
+ * // Lifecycle: "PENDING" || "EXECUTING" || "FAILED" || "SUCCEEDED" || "CANCELED" || "CANCELING",
48
+ * // TaskId: "STRING_VALUE",
49
+ * // };
50
+ *
46
51
  * ```
47
52
  *
48
53
  * @param CancelDataRepositoryTaskCommandInput - {@link CancelDataRepositoryTaskCommandInput}
@@ -66,6 +71,8 @@ export interface CancelDataRepositoryTaskCommandOutput extends CancelDataReposit
66
71
  * @throws {@link UnsupportedOperation} (client fault)
67
72
  * <p>The requested operation is not supported for this resource or API.</p>
68
73
  *
74
+ * @throws {@link FSxServiceException}
75
+ * <p>Base exception class for all service exceptions from FSx service.</p>
69
76
  *
70
77
  */
71
78
  export declare class CancelDataRepositoryTaskCommand extends $Command<CancelDataRepositoryTaskCommandInput, CancelDataRepositoryTaskCommandOutput, FSxClientResolvedConfig> {
package/dist-types/commands/CopyBackupCommand.d.ts CHANGED
@@ -61,6 +61,493 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
61
61
  * };
62
62
  * const command = new CopyBackupCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // CopyBackupResponse
65
+ * // Backup: { // Backup
66
+ * // BackupId: "STRING_VALUE", // required
67
+ * // Lifecycle: "AVAILABLE" || "CREATING" || "TRANSFERRING" || "DELETED" || "FAILED" || "PENDING" || "COPYING", // required
68
+ * // FailureDetails: { // BackupFailureDetails
69
+ * // Message: "STRING_VALUE",
70
+ * // },
71
+ * // Type: "AUTOMATIC" || "USER_INITIATED" || "AWS_BACKUP", // required
72
+ * // ProgressPercent: Number("int"),
73
+ * // CreationTime: new Date("TIMESTAMP"), // required
74
+ * // KmsKeyId: "STRING_VALUE",
75
+ * // ResourceARN: "STRING_VALUE",
76
+ * // Tags: [ // Tags
77
+ * // { // Tag
78
+ * // Key: "STRING_VALUE", // required
79
+ * // Value: "STRING_VALUE", // required
80
+ * // },
81
+ * // ],
82
+ * // FileSystem: { // FileSystem
83
+ * // OwnerId: "STRING_VALUE",
84
+ * // CreationTime: new Date("TIMESTAMP"),
85
+ * // FileSystemId: "STRING_VALUE",
86
+ * // FileSystemType: "WINDOWS" || "LUSTRE" || "ONTAP" || "OPENZFS",
87
+ * // Lifecycle: "AVAILABLE" || "CREATING" || "FAILED" || "DELETING" || "MISCONFIGURED" || "UPDATING" || "MISCONFIGURED_UNAVAILABLE",
88
+ * // FailureDetails: { // FileSystemFailureDetails
89
+ * // Message: "STRING_VALUE",
90
+ * // },
91
+ * // StorageCapacity: Number("int"),
92
+ * // StorageType: "SSD" || "HDD",
93
+ * // VpcId: "STRING_VALUE",
94
+ * // SubnetIds: [ // SubnetIds
95
+ * // "STRING_VALUE",
96
+ * // ],
97
+ * // NetworkInterfaceIds: [ // NetworkInterfaceIds
98
+ * // "STRING_VALUE",
99
+ * // ],
100
+ * // DNSName: "STRING_VALUE",
101
+ * // KmsKeyId: "STRING_VALUE",
102
+ * // ResourceARN: "STRING_VALUE",
103
+ * // Tags: [
104
+ * // {
105
+ * // Key: "STRING_VALUE", // required
106
+ * // Value: "STRING_VALUE", // required
107
+ * // },
108
+ * // ],
109
+ * // WindowsConfiguration: { // WindowsFileSystemConfiguration
110
+ * // ActiveDirectoryId: "STRING_VALUE",
111
+ * // SelfManagedActiveDirectoryConfiguration: { // SelfManagedActiveDirectoryAttributes
112
+ * // DomainName: "STRING_VALUE",
113
+ * // OrganizationalUnitDistinguishedName: "STRING_VALUE",
114
+ * // FileSystemAdministratorsGroup: "STRING_VALUE",
115
+ * // UserName: "STRING_VALUE",
116
+ * // DnsIps: [ // DnsIps
117
+ * // "STRING_VALUE",
118
+ * // ],
119
+ * // },
120
+ * // DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2",
121
+ * // RemoteAdministrationEndpoint: "STRING_VALUE",
122
+ * // PreferredSubnetId: "STRING_VALUE",
123
+ * // PreferredFileServerIp: "STRING_VALUE",
124
+ * // ThroughputCapacity: Number("int"),
125
+ * // MaintenanceOperationsInProgress: [ // FileSystemMaintenanceOperations
126
+ * // "PATCHING" || "BACKING_UP",
127
+ * // ],
128
+ * // WeeklyMaintenanceStartTime: "STRING_VALUE",
129
+ * // DailyAutomaticBackupStartTime: "STRING_VALUE",
130
+ * // AutomaticBackupRetentionDays: Number("int"),
131
+ * // CopyTagsToBackups: true || false,
132
+ * // Aliases: [ // Aliases
133
+ * // { // Alias
134
+ * // Name: "STRING_VALUE",
135
+ * // Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED",
136
+ * // },
137
+ * // ],
138
+ * // AuditLogConfiguration: { // WindowsAuditLogConfiguration
139
+ * // FileAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
140
+ * // FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
141
+ * // AuditLogDestination: "STRING_VALUE",
142
+ * // },
143
+ * // },
144
+ * // LustreConfiguration: { // LustreFileSystemConfiguration
145
+ * // WeeklyMaintenanceStartTime: "STRING_VALUE",
146
+ * // DataRepositoryConfiguration: { // DataRepositoryConfiguration
147
+ * // Lifecycle: "CREATING" || "AVAILABLE" || "MISCONFIGURED" || "UPDATING" || "DELETING" || "FAILED",
148
+ * // ImportPath: "STRING_VALUE",
149
+ * // ExportPath: "STRING_VALUE",
150
+ * // ImportedFileChunkSize: Number("int"),
151
+ * // AutoImportPolicy: "NONE" || "NEW" || "NEW_CHANGED" || "NEW_CHANGED_DELETED",
152
+ * // FailureDetails: { // DataRepositoryFailureDetails
153
+ * // Message: "STRING_VALUE",
154
+ * // },
155
+ * // },
156
+ * // DeploymentType: "SCRATCH_1" || "SCRATCH_2" || "PERSISTENT_1" || "PERSISTENT_2",
157
+ * // PerUnitStorageThroughput: Number("int"),
158
+ * // MountName: "STRING_VALUE",
159
+ * // DailyAutomaticBackupStartTime: "STRING_VALUE",
160
+ * // AutomaticBackupRetentionDays: Number("int"),
161
+ * // CopyTagsToBackups: true || false,
162
+ * // DriveCacheType: "NONE" || "READ",
163
+ * // DataCompressionType: "NONE" || "LZ4",
164
+ * // LogConfiguration: { // LustreLogConfiguration
165
+ * // Level: "DISABLED" || "WARN_ONLY" || "ERROR_ONLY" || "WARN_ERROR", // required
166
+ * // Destination: "STRING_VALUE",
167
+ * // },
168
+ * // RootSquashConfiguration: { // LustreRootSquashConfiguration
169
+ * // RootSquash: "STRING_VALUE",
170
+ * // NoSquashNids: [ // LustreNoSquashNids
171
+ * // "STRING_VALUE",
172
+ * // ],
173
+ * // },
174
+ * // },
175
+ * // AdministrativeActions: [ // AdministrativeActions
176
+ * // { // AdministrativeAction
177
+ * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE",
178
+ * // ProgressPercent: Number("int"),
179
+ * // RequestTime: new Date("TIMESTAMP"),
180
+ * // Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING",
181
+ * // TargetFileSystemValues: {
182
+ * // OwnerId: "STRING_VALUE",
183
+ * // CreationTime: new Date("TIMESTAMP"),
184
+ * // FileSystemId: "STRING_VALUE",
185
+ * // FileSystemType: "WINDOWS" || "LUSTRE" || "ONTAP" || "OPENZFS",
186
+ * // Lifecycle: "AVAILABLE" || "CREATING" || "FAILED" || "DELETING" || "MISCONFIGURED" || "UPDATING" || "MISCONFIGURED_UNAVAILABLE",
187
+ * // FailureDetails: {
188
+ * // Message: "STRING_VALUE",
189
+ * // },
190
+ * // StorageCapacity: Number("int"),
191
+ * // StorageType: "SSD" || "HDD",
192
+ * // VpcId: "STRING_VALUE",
193
+ * // SubnetIds: [
194
+ * // "STRING_VALUE",
195
+ * // ],
196
+ * // NetworkInterfaceIds: [
197
+ * // "STRING_VALUE",
198
+ * // ],
199
+ * // DNSName: "STRING_VALUE",
200
+ * // KmsKeyId: "STRING_VALUE",
201
+ * // ResourceARN: "STRING_VALUE",
202
+ * // Tags: "<Tags>",
203
+ * // WindowsConfiguration: {
204
+ * // ActiveDirectoryId: "STRING_VALUE",
205
+ * // SelfManagedActiveDirectoryConfiguration: {
206
+ * // DomainName: "STRING_VALUE",
207
+ * // OrganizationalUnitDistinguishedName: "STRING_VALUE",
208
+ * // FileSystemAdministratorsGroup: "STRING_VALUE",
209
+ * // UserName: "STRING_VALUE",
210
+ * // DnsIps: [
211
+ * // "STRING_VALUE",
212
+ * // ],
213
+ * // },
214
+ * // DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2",
215
+ * // RemoteAdministrationEndpoint: "STRING_VALUE",
216
+ * // PreferredSubnetId: "STRING_VALUE",
217
+ * // PreferredFileServerIp: "STRING_VALUE",
218
+ * // ThroughputCapacity: Number("int"),
219
+ * // MaintenanceOperationsInProgress: [
220
+ * // "PATCHING" || "BACKING_UP",
221
+ * // ],
222
+ * // WeeklyMaintenanceStartTime: "STRING_VALUE",
223
+ * // DailyAutomaticBackupStartTime: "STRING_VALUE",
224
+ * // AutomaticBackupRetentionDays: Number("int"),
225
+ * // CopyTagsToBackups: true || false,
226
+ * // Aliases: [
227
+ * // {
228
+ * // Name: "STRING_VALUE",
229
+ * // Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED",
230
+ * // },
231
+ * // ],
232
+ * // AuditLogConfiguration: {
233
+ * // FileAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
234
+ * // FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
235
+ * // AuditLogDestination: "STRING_VALUE",
236
+ * // },
237
+ * // },
238
+ * // LustreConfiguration: {
239
+ * // WeeklyMaintenanceStartTime: "STRING_VALUE",
240
+ * // DataRepositoryConfiguration: {
241
+ * // Lifecycle: "CREATING" || "AVAILABLE" || "MISCONFIGURED" || "UPDATING" || "DELETING" || "FAILED",
242
+ * // ImportPath: "STRING_VALUE",
243
+ * // ExportPath: "STRING_VALUE",
244
+ * // ImportedFileChunkSize: Number("int"),
245
+ * // AutoImportPolicy: "NONE" || "NEW" || "NEW_CHANGED" || "NEW_CHANGED_DELETED",
246
+ * // FailureDetails: {
247
+ * // Message: "STRING_VALUE",
248
+ * // },
249
+ * // },
250
+ * // DeploymentType: "SCRATCH_1" || "SCRATCH_2" || "PERSISTENT_1" || "PERSISTENT_2",
251
+ * // PerUnitStorageThroughput: Number("int"),
252
+ * // MountName: "STRING_VALUE",
253
+ * // DailyAutomaticBackupStartTime: "STRING_VALUE",
254
+ * // AutomaticBackupRetentionDays: Number("int"),
255
+ * // CopyTagsToBackups: true || false,
256
+ * // DriveCacheType: "NONE" || "READ",
257
+ * // DataCompressionType: "NONE" || "LZ4",
258
+ * // LogConfiguration: {
259
+ * // Level: "DISABLED" || "WARN_ONLY" || "ERROR_ONLY" || "WARN_ERROR", // required
260
+ * // Destination: "STRING_VALUE",
261
+ * // },
262
+ * // RootSquashConfiguration: {
263
+ * // RootSquash: "STRING_VALUE",
264
+ * // NoSquashNids: [
265
+ * // "STRING_VALUE",
266
+ * // ],
267
+ * // },
268
+ * // },
269
+ * // AdministrativeActions: [
270
+ * // {
271
+ * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE",
272
+ * // ProgressPercent: Number("int"),
273
+ * // RequestTime: new Date("TIMESTAMP"),
274
+ * // Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING",
275
+ * // TargetFileSystemValues: "<FileSystem>",
276
+ * // FailureDetails: { // AdministrativeActionFailureDetails
277
+ * // Message: "STRING_VALUE",
278
+ * // },
279
+ * // TargetVolumeValues: { // Volume
280
+ * // CreationTime: new Date("TIMESTAMP"),
281
+ * // FileSystemId: "STRING_VALUE",
282
+ * // Lifecycle: "CREATING" || "CREATED" || "DELETING" || "FAILED" || "MISCONFIGURED" || "PENDING" || "AVAILABLE",
283
+ * // Name: "STRING_VALUE",
284
+ * // OntapConfiguration: { // OntapVolumeConfiguration
285
+ * // FlexCacheEndpointType: "NONE" || "ORIGIN" || "CACHE",
286
+ * // JunctionPath: "STRING_VALUE",
287
+ * // SecurityStyle: "UNIX" || "NTFS" || "MIXED",
288
+ * // SizeInMegabytes: Number("int"),
289
+ * // StorageEfficiencyEnabled: true || false,
290
+ * // StorageVirtualMachineId: "STRING_VALUE",
291
+ * // StorageVirtualMachineRoot: true || false,
292
+ * // TieringPolicy: { // TieringPolicy
293
+ * // CoolingPeriod: Number("int"),
294
+ * // Name: "SNAPSHOT_ONLY" || "AUTO" || "ALL" || "NONE",
295
+ * // },
296
+ * // UUID: "STRING_VALUE",
297
+ * // OntapVolumeType: "RW" || "DP" || "LS",
298
+ * // SnapshotPolicy: "STRING_VALUE",
299
+ * // CopyTagsToBackups: true || false,
300
+ * // },
301
+ * // ResourceARN: "STRING_VALUE",
302
+ * // Tags: "<Tags>",
303
+ * // VolumeId: "STRING_VALUE",
304
+ * // VolumeType: "ONTAP" || "OPENZFS",
305
+ * // LifecycleTransitionReason: { // LifecycleTransitionReason
306
+ * // Message: "STRING_VALUE",
307
+ * // },
308
+ * // AdministrativeActions: "<AdministrativeActions>",
309
+ * // OpenZFSConfiguration: { // OpenZFSVolumeConfiguration
310
+ * // ParentVolumeId: "STRING_VALUE",
311
+ * // VolumePath: "STRING_VALUE",
312
+ * // StorageCapacityReservationGiB: Number("int"),
313
+ * // StorageCapacityQuotaGiB: Number("int"),
314
+ * // RecordSizeKiB: Number("int"),
315
+ * // DataCompressionType: "NONE" || "ZSTD" || "LZ4",
316
+ * // CopyTagsToSnapshots: true || false,
317
+ * // OriginSnapshot: { // OpenZFSOriginSnapshotConfiguration
318
+ * // SnapshotARN: "STRING_VALUE",
319
+ * // CopyStrategy: "CLONE" || "FULL_COPY",
320
+ * // },
321
+ * // ReadOnly: true || false,
322
+ * // NfsExports: [ // OpenZFSNfsExports
323
+ * // { // OpenZFSNfsExport
324
+ * // ClientConfigurations: [ // OpenZFSClientConfigurations // required
325
+ * // { // OpenZFSClientConfiguration
326
+ * // Clients: "STRING_VALUE", // required
327
+ * // Options: [ // OpenZFSNfsExportOptions // required
328
+ * // "STRING_VALUE",
329
+ * // ],
330
+ * // },
331
+ * // ],
332
+ * // },
333
+ * // ],
334
+ * // UserAndGroupQuotas: [ // OpenZFSUserAndGroupQuotas
335
+ * // { // OpenZFSUserOrGroupQuota
336
+ * // Type: "USER" || "GROUP", // required
337
+ * // Id: Number("int"), // required
338
+ * // StorageCapacityQuotaGiB: Number("int"), // required
339
+ * // },
340
+ * // ],
341
+ * // RestoreToSnapshot: "STRING_VALUE",
342
+ * // DeleteIntermediateSnaphots: true || false,
343
+ * // DeleteClonedVolumes: true || false,
344
+ * // },
345
+ * // },
346
+ * // TargetSnapshotValues: { // Snapshot
347
+ * // ResourceARN: "STRING_VALUE",
348
+ * // SnapshotId: "STRING_VALUE",
349
+ * // Name: "STRING_VALUE",
350
+ * // VolumeId: "STRING_VALUE",
351
+ * // CreationTime: new Date("TIMESTAMP"),
352
+ * // Lifecycle: "PENDING" || "CREATING" || "DELETING" || "AVAILABLE",
353
+ * // LifecycleTransitionReason: {
354
+ * // Message: "STRING_VALUE",
355
+ * // },
356
+ * // Tags: "<Tags>",
357
+ * // AdministrativeActions: "<AdministrativeActions>",
358
+ * // },
359
+ * // },
360
+ * // ],
361
+ * // OntapConfiguration: { // OntapFileSystemConfiguration
362
+ * // AutomaticBackupRetentionDays: Number("int"),
363
+ * // DailyAutomaticBackupStartTime: "STRING_VALUE",
364
+ * // DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1",
365
+ * // EndpointIpAddressRange: "STRING_VALUE",
366
+ * // Endpoints: { // FileSystemEndpoints
367
+ * // Intercluster: { // FileSystemEndpoint
368
+ * // DNSName: "STRING_VALUE",
369
+ * // IpAddresses: [ // OntapEndpointIpAddresses
370
+ * // "STRING_VALUE",
371
+ * // ],
372
+ * // },
373
+ * // Management: {
374
+ * // DNSName: "STRING_VALUE",
375
+ * // IpAddresses: [
376
+ * // "STRING_VALUE",
377
+ * // ],
378
+ * // },
379
+ * // },
380
+ * // DiskIopsConfiguration: { // DiskIopsConfiguration
381
+ * // Mode: "AUTOMATIC" || "USER_PROVISIONED",
382
+ * // Iops: Number("long"),
383
+ * // },
384
+ * // PreferredSubnetId: "STRING_VALUE",
385
+ * // RouteTableIds: [ // RouteTableIds
386
+ * // "STRING_VALUE",
387
+ * // ],
388
+ * // ThroughputCapacity: Number("int"),
389
+ * // WeeklyMaintenanceStartTime: "STRING_VALUE",
390
+ * // },
391
+ * // FileSystemTypeVersion: "STRING_VALUE",
392
+ * // OpenZFSConfiguration: { // OpenZFSFileSystemConfiguration
393
+ * // AutomaticBackupRetentionDays: Number("int"),
394
+ * // CopyTagsToBackups: true || false,
395
+ * // CopyTagsToVolumes: true || false,
396
+ * // DailyAutomaticBackupStartTime: "STRING_VALUE",
397
+ * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2",
398
+ * // ThroughputCapacity: Number("int"),
399
+ * // WeeklyMaintenanceStartTime: "STRING_VALUE",
400
+ * // DiskIopsConfiguration: {
401
+ * // Mode: "AUTOMATIC" || "USER_PROVISIONED",
402
+ * // Iops: Number("long"),
403
+ * // },
404
+ * // RootVolumeId: "STRING_VALUE",
405
+ * // },
406
+ * // },
407
+ * // FailureDetails: {
408
+ * // Message: "STRING_VALUE",
409
+ * // },
410
+ * // TargetVolumeValues: {
411
+ * // CreationTime: new Date("TIMESTAMP"),
412
+ * // FileSystemId: "STRING_VALUE",
413
+ * // Lifecycle: "CREATING" || "CREATED" || "DELETING" || "FAILED" || "MISCONFIGURED" || "PENDING" || "AVAILABLE",
414
+ * // Name: "STRING_VALUE",
415
+ * // OntapConfiguration: {
416
+ * // FlexCacheEndpointType: "NONE" || "ORIGIN" || "CACHE",
417
+ * // JunctionPath: "STRING_VALUE",
418
+ * // SecurityStyle: "UNIX" || "NTFS" || "MIXED",
419
+ * // SizeInMegabytes: Number("int"),
420
+ * // StorageEfficiencyEnabled: true || false,
421
+ * // StorageVirtualMachineId: "STRING_VALUE",
422
+ * // StorageVirtualMachineRoot: true || false,
423
+ * // TieringPolicy: {
424
+ * // CoolingPeriod: Number("int"),
425
+ * // Name: "SNAPSHOT_ONLY" || "AUTO" || "ALL" || "NONE",
426
+ * // },
427
+ * // UUID: "STRING_VALUE",
428
+ * // OntapVolumeType: "RW" || "DP" || "LS",
429
+ * // SnapshotPolicy: "STRING_VALUE",
430
+ * // CopyTagsToBackups: true || false,
431
+ * // },
432
+ * // ResourceARN: "STRING_VALUE",
433
+ * // Tags: "<Tags>",
434
+ * // VolumeId: "STRING_VALUE",
435
+ * // VolumeType: "ONTAP" || "OPENZFS",
436
+ * // LifecycleTransitionReason: {
437
+ * // Message: "STRING_VALUE",
438
+ * // },
439
+ * // AdministrativeActions: "<AdministrativeActions>",
440
+ * // OpenZFSConfiguration: {
441
+ * // ParentVolumeId: "STRING_VALUE",
442
+ * // VolumePath: "STRING_VALUE",
443
+ * // StorageCapacityReservationGiB: Number("int"),
444
+ * // StorageCapacityQuotaGiB: Number("int"),
445
+ * // RecordSizeKiB: Number("int"),
446
+ * // DataCompressionType: "NONE" || "ZSTD" || "LZ4",
447
+ * // CopyTagsToSnapshots: true || false,
448
+ * // OriginSnapshot: {
449
+ * // SnapshotARN: "STRING_VALUE",
450
+ * // CopyStrategy: "CLONE" || "FULL_COPY",
451
+ * // },
452
+ * // ReadOnly: true || false,
453
+ * // NfsExports: [
454
+ * // {
455
+ * // ClientConfigurations: [ // required
456
+ * // {
457
+ * // Clients: "STRING_VALUE", // required
458
+ * // Options: [ // required
459
+ * // "STRING_VALUE",
460
+ * // ],
461
+ * // },
462
+ * // ],
463
+ * // },
464
+ * // ],
465
+ * // UserAndGroupQuotas: [
466
+ * // {
467
+ * // Type: "USER" || "GROUP", // required
468
+ * // Id: Number("int"), // required
469
+ * // StorageCapacityQuotaGiB: Number("int"), // required
470
+ * // },
471
+ * // ],
472
+ * // RestoreToSnapshot: "STRING_VALUE",
473
+ * // DeleteIntermediateSnaphots: true || false,
474
+ * // DeleteClonedVolumes: true || false,
475
+ * // },
476
+ * // },
477
+ * // TargetSnapshotValues: {
478
+ * // ResourceARN: "STRING_VALUE",
479
+ * // SnapshotId: "STRING_VALUE",
480
+ * // Name: "STRING_VALUE",
481
+ * // VolumeId: "STRING_VALUE",
482
+ * // CreationTime: new Date("TIMESTAMP"),
483
+ * // Lifecycle: "PENDING" || "CREATING" || "DELETING" || "AVAILABLE",
484
+ * // LifecycleTransitionReason: {
485
+ * // Message: "STRING_VALUE",
486
+ * // },
487
+ * // Tags: "<Tags>",
488
+ * // AdministrativeActions: "<AdministrativeActions>",
489
+ * // },
490
+ * // },
491
+ * // ],
492
+ * // OntapConfiguration: {
493
+ * // AutomaticBackupRetentionDays: Number("int"),
494
+ * // DailyAutomaticBackupStartTime: "STRING_VALUE",
495
+ * // DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1",
496
+ * // EndpointIpAddressRange: "STRING_VALUE",
497
+ * // Endpoints: {
498
+ * // Intercluster: {
499
+ * // DNSName: "STRING_VALUE",
500
+ * // IpAddresses: [
501
+ * // "STRING_VALUE",
502
+ * // ],
503
+ * // },
504
+ * // Management: {
505
+ * // DNSName: "STRING_VALUE",
506
+ * // IpAddresses: [
507
+ * // "STRING_VALUE",
508
+ * // ],
509
+ * // },
510
+ * // },
511
+ * // DiskIopsConfiguration: {
512
+ * // Mode: "AUTOMATIC" || "USER_PROVISIONED",
513
+ * // Iops: Number("long"),
514
+ * // },
515
+ * // PreferredSubnetId: "STRING_VALUE",
516
+ * // RouteTableIds: [
517
+ * // "STRING_VALUE",
518
+ * // ],
519
+ * // ThroughputCapacity: Number("int"),
520
+ * // WeeklyMaintenanceStartTime: "STRING_VALUE",
521
+ * // },
522
+ * // FileSystemTypeVersion: "STRING_VALUE",
523
+ * // OpenZFSConfiguration: {
524
+ * // AutomaticBackupRetentionDays: Number("int"),
525
+ * // CopyTagsToBackups: true || false,
526
+ * // CopyTagsToVolumes: true || false,
527
+ * // DailyAutomaticBackupStartTime: "STRING_VALUE",
528
+ * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2",
529
+ * // ThroughputCapacity: Number("int"),
530
+ * // WeeklyMaintenanceStartTime: "STRING_VALUE",
531
+ * // DiskIopsConfiguration: {
532
+ * // Mode: "AUTOMATIC" || "USER_PROVISIONED",
533
+ * // Iops: Number("long"),
534
+ * // },
535
+ * // RootVolumeId: "STRING_VALUE",
536
+ * // },
537
+ * // },
538
+ * // DirectoryInformation: { // ActiveDirectoryBackupAttributes
539
+ * // DomainName: "STRING_VALUE",
540
+ * // ActiveDirectoryId: "STRING_VALUE",
541
+ * // ResourceARN: "STRING_VALUE",
542
+ * // },
543
+ * // OwnerId: "STRING_VALUE",
544
+ * // SourceBackupId: "STRING_VALUE",
545
+ * // SourceBackupRegion: "STRING_VALUE",
546
+ * // ResourceType: "FILE_SYSTEM" || "VOLUME",
547
+ * // Volume: "<Volume>",
548
+ * // },
549
+ * // };
550
+ *
64
551
  * ```
65
552
  *
66
553
  * @param CopyBackupCommandInput - {@link CopyBackupCommandInput}
@@ -110,6 +597,8 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
110
597
  * @throws {@link UnsupportedOperation} (client fault)
111
598
  * <p>The requested operation is not supported for this resource or API.</p>
112
599
  *
600
+ * @throws {@link FSxServiceException}
601
+ * <p>Base exception class for all service exceptions from FSx service.</p>
113
602
  *
114
603
  * @example To copy a backup
115
604
  * ```javascript