Package-level declarations

Types

Link copied to clipboard

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

Link copied to clipboard

An Active Directory error.

Link copied to clipboard

The type of error relating to Microsoft Active Directory. NOT_FOUND means that no directory was found by specifying the given directory. INCOMPATIBLE_MODE means that the directory specified is not a Microsoft AD directory. WRONG_VPC means that the specified directory isn't accessible from the specified VPC. WRONG_STAGE means that the specified directory isn't currently in the ACTIVE state.

Link copied to clipboard

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

Link copied to clipboard

Provides information about a failed administrative action.

Link copied to clipboard

Describes the type of administrative action, as follows:

Link copied to clipboard

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

Link copied to clipboard
class 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.

Link copied to clipboard
sealed class AliasLifecycle
Link copied to clipboard

The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
class 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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class BackupLifecycle

The lifecycle status of the backup.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class BackupType

The type of the backup.

Link copied to clipboard

A generic error indicating a failure with a client request.

Link copied to clipboard

Cancels a data repository task.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Used to specify the configuration options for a volume's storage aggregate or aggregates.

Link copied to clipboard

The request object for the CreateBackup operation.

Link copied to clipboard

The response object for the CreateBackup operation.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request object for the CreateFileSystemFromBackup operation.

Link copied to clipboard

The response object for the CreateFileSystemFromBackup operation.

Link copied to clipboard

The Lustre configuration for the file system being created.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The request object used to create a new Amazon FSx file system.

Link copied to clipboard

The response object returned after the file system is created.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class DataCompressionType
Link copied to clipboard

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:

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

A description of the data repository task.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

(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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

The request object for the DeleteBackup operation.

Link copied to clipboard

The response object for the DeleteBackup operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The request object for DeleteFileSystem operation.

Link copied to clipboard

The response object for the DeleteFileSystem operation.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request object for the DescribeBackups operation.

Link copied to clipboard

Response object for the DescribeBackups operation.

Link copied to clipboard
Link copied to clipboard

The request object for DescribeFileSystemAliases operation.

Link copied to clipboard

The response object for DescribeFileSystemAliases operation.

Link copied to clipboard

The request object for DescribeFileSystems operation.

Link copied to clipboard

The response object for DescribeFileSystems operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.

Link copied to clipboard

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.

Link copied to clipboard

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).

Link copied to clipboard
Link copied to clipboard
sealed class DriveCacheType
Link copied to clipboard

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.

Link copied to clipboard
sealed class EventType
Link copied to clipboard
class FileCache

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

A structure providing details of any failures that occurred.

Link copied to clipboard
sealed class FileCacheLifecycle
Link copied to clipboard

The configuration for the Amazon File Cache resource.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

No caches were found based upon supplied parameters.

Link copied to clipboard
sealed class FileCacheType
Link copied to clipboard

A description of a specific Amazon FSx file system.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

A structure providing details of any failures that occurred.

Link copied to clipboard
sealed class FileSystemLifecycle

The lifecycle status of the file system.

Link copied to clipboard

An enumeration specifying the currently ongoing maintenance operation.

Link copied to clipboard

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

Link copied to clipboard
sealed class FileSystemType

The type of file system.

Link copied to clipboard
class 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.

Link copied to clipboard
sealed class FilterName

The name for a filter.

Link copied to clipboard
Link copied to clipboard

Base class for all service related exceptions thrown by the FSx client

Link copied to clipboard
sealed class FSxUnit
Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

A generic error indicating a server-side failure.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Describes why a resource lifecycle state changed.

Link copied to clipboard

The request object for ListTagsForResource operation.

Link copied to clipboard

The response object for ListTagsForResource operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The configuration for the Amazon FSx for Lustre file system.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

A cache configuration is required for this operation.

Link copied to clipboard

A file system configuration is required for this operation.

Link copied to clipboard

A volume configuration is required for this operation.

Link copied to clipboard

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

Link copied to clipboard
sealed class NfsVersion
Link copied to clipboard

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.

Link copied to clipboard
sealed class OntapDeploymentType
Link copied to clipboard

Configuration for the FSx for NetApp ONTAP file system.

Link copied to clipboard

The configuration of an Amazon FSx for NetApp ONTAP volume.

Link copied to clipboard
sealed class OntapVolumeType
Link copied to clipboard

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

Link copied to clipboard
sealed class OpenZfsCopyStrategy
Link copied to clipboard

The configuration of an Amazon FSx for OpenZFS root volume.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The configuration for the Amazon FSx for OpenZFS file system.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class OpenZfsQuotaType
Link copied to clipboard

The configuration for how much storage a user or group can use on the volume.

Link copied to clipboard

The configuration of an Amazon FSx for OpenZFS volume.

Link copied to clipboard
sealed class PrivilegedDelete
Link copied to clipboard

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.

Link copied to clipboard
sealed class ReportFormat
Link copied to clipboard
sealed class ReportScope
Link copied to clipboard

The resource specified does not support tagging.

Link copied to clipboard

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

Link copied to clipboard
sealed class ResourceType
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
sealed class RetentionPeriodType
Link copied to clipboard

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.

Link copied to clipboard
sealed class SecurityStyle
Link copied to clipboard

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.

Link copied to clipboard

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.

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

Link copied to clipboard
sealed class ServiceLimit

The types of limits on your service utilization. Limits include file system count, total throughput capacity, total storage, and total user-initiated backups. These limits apply for a specific account in a specific Amazon Web Services Region. You can increase some of them by contacting Amazon Web Services Support.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
sealed class SnaplockType
Link copied to clipboard
class Snapshot

A snapshot of an Amazon FSx for OpenZFS volume.

Link copied to clipboard

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

Link copied to clipboard
sealed class SnapshotFilterName
Link copied to clipboard
sealed class SnapshotLifecycle
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class Status
Link copied to clipboard
sealed class StorageType

Specifies the file system's storage type.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
class Tag

Specifies a key-value pair for a resource tag.

Link copied to clipboard

The request object for the TagResource operation.

Link copied to clipboard

The response object for the TagResource operation.

Link copied to clipboard

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.

Link copied to clipboard
sealed class TieringPolicyName
Link copied to clipboard

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

Link copied to clipboard

The request object for UntagResource action.

Link copied to clipboard

The response object for UntagResource action.

Link copied to clipboard

The configuration update for an Amazon File Cache resource.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The request object for the UpdateFileSystem operation.

Link copied to clipboard

The response object for the UpdateFileSystem operation.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Volume

Describes an Amazon FSx volume.

Link copied to clipboard

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.

Link copied to clipboard
sealed class VolumeFilterName
Link copied to clipboard
sealed class VolumeLifecycle
Link copied to clipboard

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

Link copied to clipboard
sealed class VolumeStyle
Link copied to clipboard
sealed class VolumeType
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

The configuration for this Microsoft Windows file system.