Namespace Amazon.FSx.Model

Classes

ActiveDirectoryBackupAttributes: The Microsoft Active Directory attributes of the Amazon FSx for Windows File Server file system.

ActiveDirectoryErrorException: An Active Directory error.

AdministrativeAction: Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume.

AdministrativeActionFailureDetails: Provides information about a failed administrative action.

AggregateConfiguration: Used to specify configuration options for a volume’s storage aggregate or aggregates.

Alias: A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide.

Container for the parameters to the AssociateFileSystemAliases operation. Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.

AssociateFileSystemAliasesResponse: The system generated response showing the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system. It can take up to 2.5 minutes for the alias status to change from CREATING to AVAILABLE.

AutoExportPolicy

Describes a data repository association's automatic export policy. The AutoExportPolicy defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.

The AutoExportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

AutoImportPolicy

Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.

The AutoImportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

AutocommitPeriod

Sets the autocommit period of files in an FSx for ONTAP SnapLock volume, which determines how long the files must remain unmodified before they're automatically transitioned to the write once, read many (WORM) state.

For more information, see Autocommit.

Backup: A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.

BackupBeingCopiedException: You can't delete a backup while it's being copied.

BackupFailureDetails: If backup creation fails, this structure contains the details of that failure.

BackupInProgressException: Another backup is already under way. Wait for completion before initiating additional backups of this file system.

BackupNotFoundException: No Amazon FSx backups were found based upon the supplied parameters.

BackupRestoringException: You can't delete a backup while it's being used to restore a file system.

BadRequestException: A generic error indicating a failure with a client request.

CancelDataRepositoryTaskRequest

Container for the parameters to the CancelDataRepositoryTask operation. Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel am export task, Amazon FSx does the following.

Any files that FSx has already exported are not reverted.
FSx continues to export any files that are in-flight when the cancel operation is received.
FSx does not export any files that have not yet been exported.

For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.

CancelDataRepositoryTaskResponse: This is the response object from the CancelDataRepositoryTask operation.

CompletionReport: Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.

CopyBackupRequest

Container for the parameters to the CopyBackup operation. Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.

You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).

You can also use backup copies to clone your file dataset to another Region or within the same Region.

You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).

For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.

CopyBackupResponse: This is the response object from the CopyBackup operation.

CopySnapshotAndUpdateVolumeRequest: Container for the parameters to the CopySnapshotAndUpdateVolume operation. Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see on-demand data replication in the Amazon FSx for OpenZFS User Guide.

CopySnapshotAndUpdateVolumeResponse: This is the response object from the CopySnapshotAndUpdateVolume operation.

CreateAggregateConfiguration: Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.

CreateBackupRequest

Container for the parameters to the CreateBackup operation. Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.

For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:

A Persistent deployment type
Are not linked to a data repository

For more information about backups, see the following:

For Amazon FSx for Lustre, see Working with FSx for Lustre backups.
For Amazon FSx for Windows, see Working with FSx for Windows backups.
For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.
For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups.

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

Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.

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

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

CreateBackupResponse: The response object for the CreateBackup operation.

CreateDataRepositoryAssociationRequest

Container for the parameters to the CreateDataRepositoryAssociation operation. Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

note

CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.

CreateDataRepositoryAssociationResponse: This is the response object from the CreateDataRepositoryAssociation operation.

CreateDataRepositoryTaskRequest

Container for the parameters to the CreateDataRepositoryTask operation. Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system.

You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository.

You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre file system.

To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

CreateDataRepositoryTaskResponse: This is the response object from the CreateDataRepositoryTask operation.

CreateFileCacheLustreConfiguration: The Amazon File Cache configuration for the cache that you are creating.

CreateFileCacheRequest

Container for the parameters to the CreateFileCache operation. Creates a new Amazon File Cache resource.

You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn't exist, CreateFileCache does the following:

Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the cache in JSON format.

note

The CreateFileCache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.

CreateFileCacheResponse: This is the response object from the CreateFileCache operation.

CreateFileSystemFromBackupRequest

Container for the parameters to the CreateFileSystemFromBackup operation. Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

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

Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.

Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.

note

The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

CreateFileSystemFromBackupResponse: The response object for the CreateFileSystemFromBackup operation.

CreateFileSystemLustreConfiguration

The Lustre configuration for the file system being created.

note

The following parameters are not supported for file systems with a data repository association created with .

AutoImportPolicy
ExportPath
ImportedFileChunkSize
ImportPath

CreateFileSystemLustreMetadataConfiguration

The Lustre metadata performance configuration for the creation of an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. The configuration uses a Metadata IOPS value to set the maximum rate of metadata disk IOPS supported by the file system.

After creation, the file system supports increasing metadata performance. For more information on Metadata IOPS, see Lustre metadata performance configuration in the Amazon FSx for Lustre User Guide.

CreateFileSystemOntapConfiguration: The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

CreateFileSystemOpenZFSConfiguration: The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

CreateFileSystemRequest

Container for the parameters to the CreateFileSystem operation. Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:

Amazon FSx for Lustre
Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

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

Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system in JSON format.

note

The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

CreateFileSystemResponse: The response object returned after the file system is created.

CreateFileSystemWindowsConfiguration: The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.

CreateOntapVolumeConfiguration: Specifies the configuration of the ONTAP volume that you are creating.

CreateOpenZFSOriginSnapshotConfiguration: The snapshot configuration to use when creating an Amazon FSx for OpenZFS volume from a snapshot.

CreateOpenZFSVolumeConfiguration: Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

CreateSnaplockConfiguration: Defines the SnapLock configuration when creating an FSx for ONTAP SnapLock volume.

CreateSnapshotRequest

Container for the parameters to the CreateSnapshot operation. 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.

CreateSnapshotResponse: This is the response object from the CreateSnapshot operation.

CreateStorageVirtualMachineRequest: Container for the parameters to the CreateStorageVirtualMachine operation. Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

CreateStorageVirtualMachineResponse: This is the response object from the CreateStorageVirtualMachine operation.

CreateSvmActiveDirectoryConfiguration: The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.

CreateVolumeFromBackupRequest: Container for the parameters to the CreateVolumeFromBackup operation. Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.

CreateVolumeFromBackupResponse: This is the response object from the CreateVolumeFromBackup operation.

CreateVolumeRequest: Container for the parameters to the CreateVolume operation. Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

CreateVolumeResponse: This is the response object from the CreateVolume operation.

DataRepositoryAssociation

The configuration of a data repository association that links an Amazon FSx for Lustre file system to an Amazon S3 bucket or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system. The data repository association configuration object is returned in the response of the following operations:

CreateDataRepositoryAssociation
UpdateDataRepositoryAssociation
DescribeDataRepositoryAssociations

Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

DataRepositoryAssociationNotFoundException: No data repository associations were found based upon the supplied parameters.

DataRepositoryConfiguration

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

DataRepositoryFailureDetails: Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

DataRepositoryTask

A description of the data repository task.

You use import and export data repository tasks to perform bulk transfer operations between an Amazon FSx for Lustre file system and a linked data repository.
You use release data repository tasks to release files that have been exported to a linked S3 bucket from your Amazon FSx for Lustre file system.
An Amazon File Cache resource uses a task to automatically release files from the cache.

To learn more about data repository tasks, see Data Repository Tasks.

DataRepositoryTaskEndedException: The data repository task could not be canceled because the task has already ended.

DataRepositoryTaskExecutingException: An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.

DataRepositoryTaskFailureDetails: Provides information about why a data repository task failed. Only populated when the task Lifecycle is set to FAILED.

DataRepositoryTaskFilter: (Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter Name, and one or more Values for the filter.

DataRepositoryTaskNotFoundException: The data repository task or tasks you specified could not be found.

DataRepositoryTaskStatus: Provides the task status showing a running total of the total number of files to be processed, the number successfully processed, and the number of files the task failed to process.

DeleteBackupRequest

Container for the parameters to the DeleteBackup operation. Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup won't show up in later DescribeBackups calls.

The data in a deleted backup is also deleted and can't be recovered by any means.

DeleteBackupResponse: The response object for the DeleteBackup operation.

DeleteDataRepositoryAssociationRequest: Container for the parameters to the DeleteDataRepositoryAssociation operation. Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

DeleteDataRepositoryAssociationResponse: This is the response object from the DeleteDataRepositoryAssociation operation.

DeleteFileCacheRequest

Container for the parameters to the DeleteFileCache operation. Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.

The DeleteFileCache operation returns while the cache has the DELETING status. You can check the cache deletion status by calling the DescribeFileCaches operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the DescribeFileCaches operation returns a FileCacheNotFound error.

The data in a deleted cache is also deleted and can't be recovered by any means.

DeleteFileCacheResponse: This is the response object from the DeleteFileCache operation.

DeleteFileSystemLustreConfiguration: The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

DeleteFileSystemLustreResponse: The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

DeleteFileSystemOpenZFSConfiguration: The configuration object for the Amazon FSx for OpenZFS file system used in the DeleteFileSystem operation.

DeleteFileSystemOpenZFSResponse: The response object for the Amazon FSx for OpenZFS file system that's being deleted in the DeleteFileSystem operation.

DeleteFileSystemRequest

Container for the parameters to the DeleteFileSystem operation. Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.

To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a FileSystemId value to the DeleteFileSystem operation.

By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted.

To delete an Amazon FSx for Lustre file system, first unmount it from every connected Amazon EC2 instance, then provide a FileSystemId value to the DeleteFileSystem operation. By default, Amazon FSx will not take a final backup when the DeleteFileSystem operation is invoked. On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup to false to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository task. If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task.

The DeleteFileSystem operation returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems operation returns a FileSystemNotFound error.

note

If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).

The data in a deleted file system is also deleted and can't be recovered by any means.

DeleteFileSystemResponse: The response object for the DeleteFileSystem operation.

DeleteFileSystemWindowsConfiguration: The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.

DeleteFileSystemWindowsResponse: The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.

DeleteSnapshotRequest

Container for the parameters to the DeleteSnapshot operation. Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.

The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.

DeleteSnapshotResponse: This is the response object from the DeleteSnapshot operation.

DeleteStorageVirtualMachineRequest: Container for the parameters to the DeleteStorageVirtualMachine operation. Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.

DeleteStorageVirtualMachineResponse: This is the response object from the DeleteStorageVirtualMachine operation.

DeleteVolumeOntapConfiguration: Use to specify skipping a final backup, adding tags to a final backup, or bypassing the retention period of an FSx for ONTAP SnapLock Enterprise volume when deleting an FSx for ONTAP volume.

DeleteVolumeOntapResponse: The response object for the Amazon FSx for NetApp ONTAP volume being deleted in the DeleteVolume operation.

DeleteVolumeOpenZFSConfiguration: A value that specifies whether to delete all child volumes and snapshots.

DeleteVolumeRequest: Container for the parameters to the DeleteVolume operation. Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

DeleteVolumeResponse: This is the response object from the DeleteVolume operation.

DescribeBackupsRequest

Container for the parameters to the DescribeBackups operation. Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of the NextToken value from the last response.

This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.

When using this operation, keep the following in mind:

The operation might return fewer than the MaxResults value of backup descriptions while still including a NextToken value.
The order of the backups returned in the response of one DescribeBackups call and the order of the backups returned across the responses of a multi-call iteration is unspecified.

DescribeBackupsResponse: Response object for the DescribeBackups operation.

DescribeDataRepositoryAssociationsRequest

Container for the parameters to the DescribeDataRepositoryAssociations operation. Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1 deployment type.

You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all data repository associations, you can paginate the response by using the optional MaxResults parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

DescribeDataRepositoryAssociationsResponse: This is the response object from the DescribeDataRepositoryAssociations operation.

DescribeDataRepositoryTasksRequest

Container for the parameters to the DescribeDataRepositoryTasks operation. Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

DescribeDataRepositoryTasksResponse: This is the response object from the DescribeDataRepositoryTasks operation.

DescribeFileCachesRequest

Container for the parameters to the DescribeFileCaches operation. Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this operation, keep the following in mind:

The implementation might return fewer than MaxResults cache descriptions while still including a NextToken value.
The order of caches returned in the response of one DescribeFileCaches call and the order of caches returned across the responses of a multicall iteration is unspecified.

DescribeFileCachesResponse: This is the response object from the DescribeFileCaches operation.

DescribeFileSystemAliasesRequest: Container for the parameters to the DescribeFileSystemAliases operation. Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.

DescribeFileSystemAliasesResponse: The response object for DescribeFileSystemAliases operation.

DescribeFileSystemsRequest

Container for the parameters to the DescribeFileSystems operation. Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this operation, keep the following in mind:

The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

DescribeFileSystemsResponse: The response object for DescribeFileSystems operation.

DescribeSharedVpcConfigurationRequest: Container for the parameters to the DescribeSharedVpcConfiguration operation. Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared subnets.

DescribeSharedVpcConfigurationResponse: This is the response object from the DescribeSharedVpcConfiguration operation.

DescribeSnapshotsRequest

Container for the parameters to the DescribeSnapshots operation. Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.

When using this operation, keep the following in mind:

The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value.
The order of snapshots returned in the response of one DescribeSnapshots call and the order of backups returned across the responses of a multi-call iteration is unspecified.

DescribeSnapshotsResponse: This is the response object from the DescribeSnapshots operation.

DescribeStorageVirtualMachinesRequest: Container for the parameters to the DescribeStorageVirtualMachines operation. Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).

DescribeStorageVirtualMachinesResponse: This is the response object from the DescribeStorageVirtualMachines operation.

DescribeVolumesRequest: Container for the parameters to the DescribeVolumes operation. Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.

DescribeVolumesResponse: This is the response object from the DescribeVolumes operation.

DisassociateFileSystemAliasesRequest

Container for the parameters to the DisassociateFileSystemAliases operation. Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with an HTTP status code 400 (Bad Request). For more information, see Working with DNS Aliases.

The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.

DisassociateFileSystemAliasesResponse: The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.

DiskIopsConfiguration: The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

DurationSinceLastAccess: Defines the minimum amount of time since last access for a file to be eligible for release. Only files that have been exported to S3 and that were last accessed or modified before this point-in-time are eligible to be released from the Amazon FSx for Lustre file system.

FSxPaginatorFactory: Paginators for the FSx service

FileCache: A description of a specific Amazon File Cache resource, which is a response object from the DescribeFileCaches operation.

FileCacheCreating: The response object for the Amazon File Cache resource being created in the CreateFileCache operation.

FileCacheDataRepositoryAssociation

The configuration for a data repository association (DRA) to be created during the Amazon File Cache resource creation. The DRA links the cache to either an Amazon S3 bucket or prefix, or a Network File System (NFS) data repository that supports the NFSv3 protocol.

The DRA does not support automatic import or automatic export.

FileCacheFailureDetails: A structure providing details of any failures that occurred.

FileCacheLustreConfiguration: The configuration for the Amazon File Cache resource.

FileCacheLustreMetadataConfiguration: The configuration for a Lustre MDT (Metadata Target) storage volume. The metadata on Amazon File Cache is managed by a Lustre Metadata Server (MDS) while the actual metadata is persisted on an MDT.

FileCacheNFSConfiguration: The configuration for an NFS data repository association (DRA) created during the creation of the Amazon File Cache resource.

FileCacheNotFoundException: No caches were found based upon supplied parameters.

FileSystem: A description of a specific Amazon FSx file system.

FileSystemEndpoint: An Amazon FSx for NetApp ONTAP file system has two endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. They are the Management and Intercluster endpoints.

FileSystemEndpoints: An Amazon FSx for NetApp ONTAP file system has the following endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

FileSystemFailureDetails: A structure providing details of any failures that occurred.

FileSystemLustreMetadataConfiguration: The Lustre metadata performance configuration of an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. The configuration enables the file system to support increasing metadata performance.

FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.

Filter: A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.

IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

IncompatibleRegionForMultiAZException: Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored.

InternalServerErrorException: A generic error indicating a server-side failure.

InvalidDataRepositoryTypeException: You have filtered the response to a data repository type that is not supported.

InvalidDestinationKmsKeyException: The Key Management Service (KMS) key of the destination backup is not valid.

InvalidExportPathException: The path provided for data repository export isn't valid.

InvalidImportPathException: The path provided for data repository import isn't valid.

InvalidNetworkSettingsException: One or more network settings specified in the request are invalid.

InvalidPerUnitStorageThroughputException: An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

InvalidRegionException: The Region provided for SourceRegion is not valid or is in a different Amazon Web Services partition.

InvalidSourceKmsKeyException: The Key Management Service (KMS) key of the source backup is not valid.

LifecycleTransitionReason: Describes why a resource lifecycle state changed.

ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists tags for Amazon FSx resources.

When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.

ListTagsForResourceResponse: The response object for ListTagsForResource operation.

LustreFileSystemConfiguration: The configuration for the Amazon FSx for Lustre file system.

LustreLogConfiguration: The configuration for Lustre logging used to write the enabled logging events for your Amazon FSx for Lustre file system or Amazon File Cache resource to Amazon CloudWatch Logs.

LustreLogCreateConfiguration

The Lustre logging configuration used when creating or updating an Amazon FSx for Lustre file system. An Amazon File Cache is created with Lustre logging enabled by default, with a setting of WARN_ERROR for the logging events. which can't be changed.

Lustre logging writes the enabled logging events for your file system or cache to Amazon CloudWatch Logs.

LustreRootSquashConfiguration

The configuration for Lustre root squash used to restrict root-level access from clients that try to access your FSx for Lustre file system as root. Use the RootSquash parameter to enable root squash. To learn more about Lustre root squash, see Lustre root squash.

You can also use the NoSquashNids parameter to provide an array of clients who are not affected by the root squash setting. These clients will access the file system as root, with unrestricted privileges.

MissingFileCacheConfigurationException: A cache configuration is required for this operation.

MissingFileSystemConfigurationException: A file system configuration is required for this operation.

MissingVolumeConfigurationException: A volume configuration is required for this operation.

NFSDataRepositoryConfiguration: The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

NotServiceResourceErrorException: The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

OntapFileSystemConfiguration: Configuration for the FSx for NetApp ONTAP file system.

OntapVolumeConfiguration: The configuration of an Amazon FSx for NetApp ONTAP volume.

OpenZFSClientConfiguration: Specifies who can mount an OpenZFS file system and the options available while mounting the file system.

OpenZFSCreateRootVolumeConfiguration: The configuration of an Amazon FSx for OpenZFS root volume.

OpenZFSFileSystemConfiguration: The configuration for the Amazon FSx for OpenZFS file system.

OpenZFSNfsExport: The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system.

OpenZFSOriginSnapshotConfiguration: The snapshot configuration used when creating an Amazon FSx for OpenZFS volume from a snapshot.

OpenZFSUserOrGroupQuota: Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide.

OpenZFSVolumeConfiguration: The configuration of an Amazon FSx for OpenZFS volume.

ReleaseConfiguration

The configuration that specifies a minimum amount of time since last access for an exported file to be eligible for release from an Amazon FSx for Lustre file system. Only files that were last accessed before this point-in-time can be released. For example, if you specify a last accessed time criteria of 9 days, only files that were last accessed 9.00001 or more days ago can be released.

Only file data that has been exported to S3 can be released. Files that have not yet been exported to S3, such as new or changed files that have not been exported, are not eligible for release. When files are released, their metadata stays on the file system, so they can still be accessed later. Users and applications can access a released file by reading the file again, which restores data from Amazon S3 to the FSx for Lustre file system.

note

If a file meets the last accessed time criteria, its file or directory path must also be specified with the Paths parameter of the operation in order for the file to be released.

ReleaseFileSystemNfsV3LocksRequest: Container for the parameters to the ReleaseFileSystemNfsV3Locks operation. Releases the file system lock from an Amazon FSx for OpenZFS file system.

ReleaseFileSystemNfsV3LocksResponse: This is the response object from the ReleaseFileSystemNfsV3Locks operation.

ResourceDoesNotSupportTaggingException: The resource specified does not support tagging.

ResourceNotFoundException: The resource specified by the Amazon Resource Name (ARN) can't be found.

RestoreVolumeFromSnapshotRequest: Container for the parameters to the RestoreVolumeFromSnapshot operation. Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.

RestoreVolumeFromSnapshotResponse: This is the response object from the RestoreVolumeFromSnapshot operation.

RetentionPeriod

Specifies the retention period of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Files can't be deleted or modified during the retention period.

For more information, see Working with the retention period in SnapLock.

S3DataRepositoryConfiguration: The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association. The configuration consists of an AutoImportPolicy that defines which file events on the data repository are automatically imported to the file system and an AutoExportPolicy that defines which file events on the file system are automatically exported to the data repository. File events are when files or directories are added, changed, or deleted on the file system or the data repository.

note

Data repository associations on Amazon File Cache don't use S3DataRepositoryConfiguration because they don't support automatic import or automatic export.

SelfManagedActiveDirectoryAttributes: The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

SelfManagedActiveDirectoryConfiguration: The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs.

SelfManagedActiveDirectoryConfigurationUpdates: Specifies changes you are making to the self-managed Microsoft Active Directory configuration to which an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined.

ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

SnaplockConfiguration: Specifies the SnapLock configuration for an FSx for ONTAP SnapLock volume.

SnaplockRetentionPeriod: The configuration to set the retention period of an FSx for ONTAP SnapLock volume. The retention period includes default, maximum, and minimum settings. For more information, see Working with the retention period in SnapLock.

Snapshot: A snapshot of an Amazon FSx for OpenZFS volume.

SnapshotFilter: A filter used to restrict the results of DescribeSnapshots calls. You can use multiple filters to return results that meet all applied filter requirements.

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

SourceBackupUnavailableException: The request was rejected because the lifecycle status of the source backup isn't AVAILABLE.

StartMisconfiguredStateRecoveryRequest: Container for the parameters to the StartMisconfiguredStateRecovery operation. After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system.

StartMisconfiguredStateRecoveryResponse: This is the response object from the StartMisconfiguredStateRecovery operation.

StorageVirtualMachine: Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration.

StorageVirtualMachineFilter: A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). You can use multiple filters to return results that meet all applied filter requirements.

StorageVirtualMachineNotFoundException: No FSx for ONTAP SVMs were found based upon the supplied parameters.

SvmActiveDirectoryConfiguration: Describes the Microsoft Active Directory (AD) directory configuration to which the FSx for ONTAP storage virtual machine (SVM) is joined. Note that account credentials are not returned in the response payload.

SvmEndpoint: An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.

SvmEndpoints: An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has the following endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.

Tag: Specifies a key-value pair for a resource tag.

TagResourceRequest: Container for the parameters to the TagResource operation. Tags an Amazon FSx resource.

TagResourceResponse: The response object for the TagResource operation.

TieringPolicy

Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:

SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

UnsupportedOperationException: The requested operation is not supported for this resource or API.

UntagResourceRequest: Container for the parameters to the UntagResource operation. This action removes a tag from an Amazon FSx resource.

UntagResourceResponse: The response object for UntagResource action.

UpdateDataRepositoryAssociationRequest: Container for the parameters to the UpdateDataRepositoryAssociation operation. Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

UpdateDataRepositoryAssociationResponse: This is the response object from the UpdateDataRepositoryAssociation operation.

UpdateFileCacheLustreConfiguration: The configuration update for an Amazon File Cache resource.

UpdateFileCacheRequest: Container for the parameters to the UpdateFileCache operation. Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.

UpdateFileCacheResponse: This is the response object from the UpdateFileCache operation.

UpdateFileSystemLustreConfiguration: The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

UpdateFileSystemLustreMetadataConfiguration: The Lustre metadata performance configuration update for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. You can request an increase in your file system's Metadata IOPS and/or switch your file system's metadata configuration mode. For more information, see Managing metadata performance in the Amazon FSx for Lustre User Guide.

UpdateFileSystemOntapConfiguration: The configuration updates for an Amazon FSx for NetApp ONTAP file system.

UpdateFileSystemOpenZFSConfiguration: The configuration updates for an Amazon FSx for OpenZFS file system.

UpdateFileSystemRequest

Container for the parameters to the UpdateFileSystem operation. Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.

For FSx for Windows File Server file systems, you can update the following properties:

AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
StorageType
ThroughputCapacity
DiskIopsConfiguration
WeeklyMaintenanceStartTime

For FSx for Lustre file systems, you can update the following properties:

AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
LogConfiguration
LustreRootSquashConfiguration
MetadataConfiguration
PerUnitStorageThroughput
StorageCapacity
WeeklyMaintenanceStartTime

For FSx for ONTAP file systems, you can update the following properties:

AddRouteTableIds
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DiskIopsConfiguration
FsxAdminPassword
HAPairs
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
ThroughputCapacityPerHAPair
WeeklyMaintenanceStartTime

For FSx for OpenZFS file systems, you can update the following properties:

AddRouteTableIds
AutomaticBackupRetentionDays
CopyTagsToBackups
CopyTagsToVolumes
DailyAutomaticBackupStartTime
DiskIopsConfiguration
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime

UpdateFileSystemResponse: The response object for the UpdateFileSystem operation.

UpdateFileSystemWindowsConfiguration: Updates the configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx only overwrites existing properties with non-null values provided in the request.

UpdateOntapVolumeConfiguration: Used to specify changes to the ONTAP configuration for the volume you are updating.

UpdateOpenZFSVolumeConfiguration: Used to specify changes to the OpenZFS configuration for the volume that you are updating.

UpdateSharedVpcConfigurationRequest: Container for the parameters to the UpdateSharedVpcConfiguration operation. Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide.

note

We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a MISCONFIGURED state and behave like Single-AZ file systems. For more information, see Important considerations before disabling shared VPC support for Multi-AZ file systems.

UpdateSharedVpcConfigurationResponse: This is the response object from the UpdateSharedVpcConfiguration operation.

UpdateSnaplockConfiguration: Updates the SnapLock configuration for an existing FSx for ONTAP volume.

UpdateSnapshotRequest: Container for the parameters to the UpdateSnapshot operation. Updates the name of an Amazon FSx for OpenZFS snapshot.

UpdateSnapshotResponse: This is the response object from the UpdateSnapshot operation.

UpdateStorageVirtualMachineRequest: Container for the parameters to the UpdateStorageVirtualMachine operation. Updates an FSx for ONTAP storage virtual machine (SVM).

UpdateStorageVirtualMachineResponse: This is the response object from the UpdateStorageVirtualMachine operation.

UpdateSvmActiveDirectoryConfiguration: Specifies updates to an FSx for ONTAP storage virtual machine's (SVM) Microsoft Active Directory (AD) configuration. Note that account credentials are not returned in the response payload.

UpdateVolumeRequest: Container for the parameters to the UpdateVolume operation. Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

UpdateVolumeResponse: This is the response object from the UpdateVolume operation.

Volume: Describes an Amazon FSx volume.

VolumeFilter: A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes. You can use multiple filters to return results that meet all applied filter requirements.

VolumeNotFoundException: No Amazon FSx volumes were found based upon the supplied parameters.

WindowsAuditLogConfiguration: The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. For more information, see File access auditing.

WindowsAuditLogCreateConfiguration: The Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server file system.

WindowsFileSystemConfiguration: The configuration for this Microsoft Windows file system.

Interfaces

IDescribeBackupsPaginator: Paginator for the DescribeBackups operation

IDescribeDataRepositoryAssociationsPaginator: Paginator for the DescribeDataRepositoryAssociations operation

IDescribeDataRepositoryTasksPaginator: Paginator for the DescribeDataRepositoryTasks operation

IDescribeFileCachesPaginator: Paginator for the DescribeFileCaches operation

IDescribeFileSystemAliasesPaginator: Paginator for the DescribeFileSystemAliases operation

IDescribeFileSystemsPaginator: Paginator for the DescribeFileSystems operation

IDescribeSnapshotsPaginator: Paginator for the DescribeSnapshots operation

IDescribeStorageVirtualMachinesPaginator: Paginator for the DescribeStorageVirtualMachines operation

IDescribeVolumesPaginator: Paginator for the DescribeVolumes operation

IFSxPaginatorFactory: Paginators for the FSx service

IListTagsForResourcePaginator: Paginator for the ListTagsForResource operation

Table of Contents

Namespace Amazon.FSx.Model

Classes

note

note

note

note

note

note

note

note

note

Interfaces