Awso_fsx_eioSourceval associate_file_system_aliases :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.AssociateFileSystemAliasesRequest.t ->
(Awso_fsx.Values.AssociateFileSystemAliasesResponse.t,
Awso_fsx.Values.AssociateFileSystemAliasesResponse.error)
Result.tval cancel_data_repository_task :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CancelDataRepositoryTaskRequest.t ->
(Awso_fsx.Values.CancelDataRepositoryTaskResponse.t,
Awso_fsx.Values.CancelDataRepositoryTaskResponse.error)
Result.tval copy_backup :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CopyBackupRequest.t ->
(Awso_fsx.Values.CopyBackupResponse.t,
Awso_fsx.Values.CopyBackupResponse.error)
Result.tval copy_snapshot_and_update_volume :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CopySnapshotAndUpdateVolumeRequest.t ->
(Awso_fsx.Values.CopySnapshotAndUpdateVolumeResponse.t,
Awso_fsx.Values.CopySnapshotAndUpdateVolumeResponse.error)
Result.tval create_and_attach_s3_access_point :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateAndAttachS3AccessPointRequest.t ->
(Awso_fsx.Values.CreateAndAttachS3AccessPointResponse.t,
Awso_fsx.Values.CreateAndAttachS3AccessPointResponse.error)
Result.tval create_backup :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateBackupRequest.t ->
(Awso_fsx.Values.CreateBackupResponse.t,
Awso_fsx.Values.CreateBackupResponse.error)
Result.tval create_data_repository_association :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateDataRepositoryAssociationRequest.t ->
(Awso_fsx.Values.CreateDataRepositoryAssociationResponse.t,
Awso_fsx.Values.CreateDataRepositoryAssociationResponse.error)
Result.tval create_data_repository_task :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateDataRepositoryTaskRequest.t ->
(Awso_fsx.Values.CreateDataRepositoryTaskResponse.t,
Awso_fsx.Values.CreateDataRepositoryTaskResponse.error)
Result.tval create_file_cache :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateFileCacheRequest.t ->
(Awso_fsx.Values.CreateFileCacheResponse.t,
Awso_fsx.Values.CreateFileCacheResponse.error)
Result.tval create_file_system :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateFileSystemRequest.t ->
(Awso_fsx.Values.CreateFileSystemResponse.t,
Awso_fsx.Values.CreateFileSystemResponse.error)
Result.tval create_file_system_from_backup :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateFileSystemFromBackupRequest.t ->
(Awso_fsx.Values.CreateFileSystemFromBackupResponse.t,
Awso_fsx.Values.CreateFileSystemFromBackupResponse.error)
Result.tval create_snapshot :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateSnapshotRequest.t ->
(Awso_fsx.Values.CreateSnapshotResponse.t,
Awso_fsx.Values.CreateSnapshotResponse.error)
Result.tval create_storage_virtual_machine :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateStorageVirtualMachineRequest.t ->
(Awso_fsx.Values.CreateStorageVirtualMachineResponse.t,
Awso_fsx.Values.CreateStorageVirtualMachineResponse.error)
Result.tval create_volume :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateVolumeRequest.t ->
(Awso_fsx.Values.CreateVolumeResponse.t,
Awso_fsx.Values.CreateVolumeResponse.error)
Result.tval create_volume_from_backup :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.CreateVolumeFromBackupRequest.t ->
(Awso_fsx.Values.CreateVolumeFromBackupResponse.t,
Awso_fsx.Values.CreateVolumeFromBackupResponse.error)
Result.tval delete_backup :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DeleteBackupRequest.t ->
(Awso_fsx.Values.DeleteBackupResponse.t,
Awso_fsx.Values.DeleteBackupResponse.error)
Result.tval delete_data_repository_association :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DeleteDataRepositoryAssociationRequest.t ->
(Awso_fsx.Values.DeleteDataRepositoryAssociationResponse.t,
Awso_fsx.Values.DeleteDataRepositoryAssociationResponse.error)
Result.tval delete_file_cache :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DeleteFileCacheRequest.t ->
(Awso_fsx.Values.DeleteFileCacheResponse.t,
Awso_fsx.Values.DeleteFileCacheResponse.error)
Result.tval delete_file_system :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DeleteFileSystemRequest.t ->
(Awso_fsx.Values.DeleteFileSystemResponse.t,
Awso_fsx.Values.DeleteFileSystemResponse.error)
Result.tval delete_snapshot :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DeleteSnapshotRequest.t ->
(Awso_fsx.Values.DeleteSnapshotResponse.t,
Awso_fsx.Values.DeleteSnapshotResponse.error)
Result.tval delete_storage_virtual_machine :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DeleteStorageVirtualMachineRequest.t ->
(Awso_fsx.Values.DeleteStorageVirtualMachineResponse.t,
Awso_fsx.Values.DeleteStorageVirtualMachineResponse.error)
Result.tval delete_volume :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DeleteVolumeRequest.t ->
(Awso_fsx.Values.DeleteVolumeResponse.t,
Awso_fsx.Values.DeleteVolumeResponse.error)
Result.tval describe_backups :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DescribeBackupsRequest.t ->
(Awso_fsx.Values.DescribeBackupsResponse.t,
Awso_fsx.Values.DescribeBackupsResponse.error)
Result.tval describe_data_repository_associations :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DescribeDataRepositoryAssociationsRequest.t ->
(Awso_fsx.Values.DescribeDataRepositoryAssociationsResponse.t,
Awso_fsx.Values.DescribeDataRepositoryAssociationsResponse.error)
Result.tval describe_data_repository_tasks :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DescribeDataRepositoryTasksRequest.t ->
(Awso_fsx.Values.DescribeDataRepositoryTasksResponse.t,
Awso_fsx.Values.DescribeDataRepositoryTasksResponse.error)
Result.tval describe_file_caches :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DescribeFileCachesRequest.t ->
(Awso_fsx.Values.DescribeFileCachesResponse.t,
Awso_fsx.Values.DescribeFileCachesResponse.error)
Result.tval describe_file_system_aliases :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DescribeFileSystemAliasesRequest.t ->
(Awso_fsx.Values.DescribeFileSystemAliasesResponse.t,
Awso_fsx.Values.DescribeFileSystemAliasesResponse.error)
Result.tval describe_file_systems :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DescribeFileSystemsRequest.t ->
(Awso_fsx.Values.DescribeFileSystemsResponse.t,
Awso_fsx.Values.DescribeFileSystemsResponse.error)
Result.tval describe_s3_access_point_attachments :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DescribeS3AccessPointAttachmentsRequest.t ->
(Awso_fsx.Values.DescribeS3AccessPointAttachmentsResponse.t,
Awso_fsx.Values.DescribeS3AccessPointAttachmentsResponse.error)
Result.tval describe_snapshots :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DescribeSnapshotsRequest.t ->
(Awso_fsx.Values.DescribeSnapshotsResponse.t,
Awso_fsx.Values.DescribeSnapshotsResponse.error)
Result.tval describe_storage_virtual_machines :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DescribeStorageVirtualMachinesRequest.t ->
(Awso_fsx.Values.DescribeStorageVirtualMachinesResponse.t,
Awso_fsx.Values.DescribeStorageVirtualMachinesResponse.error)
Result.tval describe_volumes :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DescribeVolumesRequest.t ->
(Awso_fsx.Values.DescribeVolumesResponse.t,
Awso_fsx.Values.DescribeVolumesResponse.error)
Result.tval detach_and_delete_s3_access_point :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DetachAndDeleteS3AccessPointRequest.t ->
(Awso_fsx.Values.DetachAndDeleteS3AccessPointResponse.t,
Awso_fsx.Values.DetachAndDeleteS3AccessPointResponse.error)
Result.tval disassociate_file_system_aliases :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.DisassociateFileSystemAliasesRequest.t ->
(Awso_fsx.Values.DisassociateFileSystemAliasesResponse.t,
Awso_fsx.Values.DisassociateFileSystemAliasesResponse.error)
Result.tval list_tags_for_resource :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.ListTagsForResourceRequest.t ->
(Awso_fsx.Values.ListTagsForResourceResponse.t,
Awso_fsx.Values.ListTagsForResourceResponse.error)
Result.tval release_file_system_nfs_v3_locks :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.ReleaseFileSystemNfsV3LocksRequest.t ->
(Awso_fsx.Values.ReleaseFileSystemNfsV3LocksResponse.t,
Awso_fsx.Values.ReleaseFileSystemNfsV3LocksResponse.error)
Result.tval restore_volume_from_snapshot :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.RestoreVolumeFromSnapshotRequest.t ->
(Awso_fsx.Values.RestoreVolumeFromSnapshotResponse.t,
Awso_fsx.Values.RestoreVolumeFromSnapshotResponse.error)
Result.tval start_misconfigured_state_recovery :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.StartMisconfiguredStateRecoveryRequest.t ->
(Awso_fsx.Values.StartMisconfiguredStateRecoveryResponse.t,
Awso_fsx.Values.StartMisconfiguredStateRecoveryResponse.error)
Result.tval tag_resource :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.TagResourceRequest.t ->
(Awso_fsx.Values.TagResourceResponse.t,
Awso_fsx.Values.TagResourceResponse.error)
Result.tval untag_resource :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.UntagResourceRequest.t ->
(Awso_fsx.Values.UntagResourceResponse.t,
Awso_fsx.Values.UntagResourceResponse.error)
Result.tval update_data_repository_association :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.UpdateDataRepositoryAssociationRequest.t ->
(Awso_fsx.Values.UpdateDataRepositoryAssociationResponse.t,
Awso_fsx.Values.UpdateDataRepositoryAssociationResponse.error)
Result.tval update_file_cache :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.UpdateFileCacheRequest.t ->
(Awso_fsx.Values.UpdateFileCacheResponse.t,
Awso_fsx.Values.UpdateFileCacheResponse.error)
Result.tval update_file_system :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.UpdateFileSystemRequest.t ->
(Awso_fsx.Values.UpdateFileSystemResponse.t,
Awso_fsx.Values.UpdateFileSystemResponse.error)
Result.tval update_snapshot :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.UpdateSnapshotRequest.t ->
(Awso_fsx.Values.UpdateSnapshotResponse.t,
Awso_fsx.Values.UpdateSnapshotResponse.error)
Result.tval update_storage_virtual_machine :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.UpdateStorageVirtualMachineRequest.t ->
(Awso_fsx.Values.UpdateStorageVirtualMachineResponse.t,
Awso_fsx.Values.UpdateStorageVirtualMachineResponse.error)
Result.tval update_volume :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_fsx.Values.UpdateVolumeRequest.t ->
(Awso_fsx.Values.UpdateVolumeResponse.t,
Awso_fsx.Values.UpdateVolumeResponse.error)
Result.tinclude module type of struct include Awso_fsx.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
A detailed error message.
An access point with that name already exists in the Amazon Web Services Region in your Amazon Web Services account.
The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
The Microsoft Active Directory attributes of the Amazon FSx for Windows File Server file system.
An Active Directory error.
A string of 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.
A string of 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the resource to which they are attached.
Specifies a key-value pair for a resource tag.
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.
module OpenZFSOriginSnapshotConfiguration =
Awso_fsx.Values.OpenZFSOriginSnapshotConfigurationThe snapshot configuration used when creating an Amazon FSx for OpenZFS volume from a snapshot.
Specifies who can mount an OpenZFS file system and the options available while mounting the file system.
The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system.
The configuration of an Amazon FSx for OpenZFS volume.
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.
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.
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.
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.
Specifies the SnapLock configuration for an FSx for ONTAP SnapLock volume.
Used to specify configuration options for a volume’s storage aggregate or aggregates.
The configuration of an Amazon FSx for NetApp ONTAP volume.
Describes why a resource lifecycle state changed.
The globally unique ID of the file system, assigned by Amazon FSx.
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
Displays the current percent of progress of an asynchronous task.
The File Server Resource Manager (FSRM) configuration that Amazon FSx for Windows File Server uses for the file system. When FSRM is enabled, you can manage and monitor storage quotas, file screening, storage reports, and file classification.
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.
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, 1:05:00 specifies maintenance at 5 AM Monday.
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.
module OrganizationalUnitDistinguishedName =
Awso_fsx.Values.OrganizationalUnitDistinguishedNamemodule SelfManagedActiveDirectoryAttributes =
Awso_fsx.Values.SelfManagedActiveDirectoryAttributesThe 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.
The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).
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).
A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
The file system's DNS name. You can mount your file system using its DNS name.
The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.
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.
The configuration for this Microsoft Windows file system.
The ID of your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.
Specifies the file system's storage capacity, in gibibytes (GiB).
The configuration for the optional provisioned SSD read cache on Amazon FSx for OpenZFS file systems that use the Intelligent-Tiering storage class.
The configuration for the Amazon FSx for OpenZFS file system.
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.
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.
Configuration for the FSx for NetApp ONTAP file system.
An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances.
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.
The configuration for the optional provisioned SSD read cache on Amazon FSx for Lustre file systems that use the Intelligent-Tiering storage class.
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.
module FileSystemLustreMetadataConfiguration =
Awso_fsx.Values.FileSystemLustreMetadataConfigurationThe 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.
Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.
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 .
The configuration for the Amazon FSx for Lustre file system.
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows: Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only. SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account. Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
A structure providing details of any failures that occurred.
module AdministrativeActionFailureDetails =
Awso_fsx.Values.AdministrativeActionFailureDetailsProvides information about a failed administrative action.
module AdministrativeAction = Awso_fsx.Values.AdministrativeActionDescribes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume.
module AdministrativeActions = Awso_fsx.Values.AdministrativeActionsmodule FileSystem = Awso_fsx.Values.FileSystemA description of a specific Amazon FSx file system.
module Snapshot = Awso_fsx.Values.SnapshotA snapshot of an Amazon FSx for OpenZFS volume.
module Volume = Awso_fsx.Values.VolumeDescribes an Amazon FSx volume.
(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.
A generic error indicating a server-side failure.
No Amazon FSx file systems were found based upon supplied parameters.
A generic error indicating a failure with a client request.
module AssociateFileSystemAliasesResponse =
Awso_fsx.Values.AssociateFileSystemAliasesResponseThe 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.
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.
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.
The ID of the source backup. Specifies the backup that you are copying.
If backup creation fails, this structure contains the details of that failure.
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.
You can't delete a backup while it's being copied.
Another backup is already under way. Wait for completion before initiating additional backups of this file system.
No Amazon FSx backups were found based upon the supplied parameters.
You can't delete a backup while it's being used to restore a file system.
Cancels a data repository task.
The requested operation is not supported for this resource or API.
The data repository task or tasks you specified could not be found.
The data repository task could not be canceled because the task has already ended.
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel an 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.
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.
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.
The request was rejected because the lifecycle status of the source backup isn't AVAILABLE.
An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
The Key Management Service (KMS) key of the source backup is not valid.
The Region provided for SourceRegion is not valid or is in a different Amazon Web Services partition.
The Key Management Service (KMS) key of the destination backup is not valid.
Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored.
The name of a parameter for the request. Parameter names are returned in PascalCase.
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.
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.
module CopySnapshotAndUpdateVolumeRequest =
Awso_fsx.Values.CopySnapshotAndUpdateVolumeRequestUpdates 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.
module CopySnapshotAndUpdateVolumeResponse =
Awso_fsx.Values.CopySnapshotAndUpdateVolumeResponseUpdates 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.
module CopyTagsToDataRepositoryAssociations =
Awso_fsx.Values.CopyTagsToDataRepositoryAssociationsUsed to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
The FSx for ONTAP Windows file system user that is used for authorizing all file access requests that are made using the S3 access point.
The FSx for ONTAP UNIX file system user that is used for authorizing all file access requests that are made using the S3 access point.
Specifies the file system user identity that will be used for authorizing all file access requests that are made using the S3 access point. The identity can be either a UNIX user or a Windows user.
module CreateAndAttachS3AccessPointOntapConfiguration =
Awso_fsx.Values.CreateAndAttachS3AccessPointOntapConfigurationSpecifies the FSx for ONTAP volume that the S3 access point will be attached to, and the file system user identity.
The FSx for OpenZFS file system user that is used for authorizing all file access requests that are made using the S3 access point.
Specifies the file system user identity that will be used for authorizing all file access requests that are made using the S3 access point.
module CreateAndAttachS3AccessPointOpenZFSConfiguration =
Awso_fsx.Values.CreateAndAttachS3AccessPointOpenZFSConfigurationSpecifies the FSx for OpenZFS volume that the S3 access point will be attached to, and the file system user identity.
If included, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).
module CreateAndAttachS3AccessPointS3Configuration =
Awso_fsx.Values.CreateAndAttachS3AccessPointS3ConfigurationUsed to create an S3 access point that accepts requests only from a virtual private cloud (VPC) to restrict data access to a private network.
module CreateAndAttachS3AccessPointRequest =
Awso_fsx.Values.CreateAndAttachS3AccessPointRequestCreates an S3 access point and attaches it to an Amazon FSx volume. For FSx for OpenZFS file systems, the volume must be hosted on a high-availability file system, either Single-AZ or Multi-AZ. For more information, see Accessing your data using Amazon S3 access points. in the Amazon FSx for OpenZFS User Guide. The requester requires the following permissions to perform these actions: fsx:CreateAndAttachS3AccessPoint s3:CreateAccessPoint s3:GetAccessPoint s3:PutAccessPointPolicy s3:DeleteAccessPoint The following actions are related to CreateAndAttachS3AccessPoint: DescribeS3AccessPointAttachments DetachAndDeleteS3AccessPoint
No Amazon FSx volumes were found based upon the supplied parameters.
You have reached the maximum number of S3 access points attachments allowed for your account in this Amazon Web Services Region, or for the file system. For more information, or to request an increase, see Service quotas on FSx resources in the FSx for OpenZFS User Guide.
Describes the FSx for OpenZFS attachment configuration of an S3 access point attachment.
Describes the FSx for ONTAP attachment configuration of an S3 access point attachment.
Describes the S3 access point configuration of the S3 access point attachment.
An S3 access point attached to an Amazon FSx volume.
The action or operation requested is invalid. Verify that the action is typed correctly.
The access point specified doesn't exist.
module CreateAndAttachS3AccessPointResponse =
Awso_fsx.Values.CreateAndAttachS3AccessPointResponseCreates an S3 access point and attaches it to an Amazon FSx volume. For FSx for OpenZFS file systems, the volume must be hosted on a high-availability file system, either Single-AZ or Multi-AZ. For more information, see Accessing your data using Amazon S3 access points. in the Amazon FSx for OpenZFS User Guide. The requester requires the following permissions to perform these actions: fsx:CreateAndAttachS3AccessPoint s3:CreateAccessPoint s3:GetAccessPoint s3:PutAccessPointPolicy s3:DeleteAccessPoint The following actions are related to CreateAndAttachS3AccessPoint: DescribeS3AccessPointAttachments DetachAndDeleteS3AccessPoint
The request object for the CreateBackup operation.
The response object for the CreateBackup operation.
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. Data repository associations on Amazon File Cache don't use S3DataRepositoryConfiguration because they don't support automatic import or automatic export.
module CreateDataRepositoryAssociationRequest =
Awso_fsx.Values.CreateDataRepositoryAssociationRequestCreates 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. CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.
The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.
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 Intelligent-Tiering and scratch_1 file systems.
module CreateDataRepositoryAssociationResponse =
Awso_fsx.Values.CreateDataRepositoryAssociationResponseCreates 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. CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.
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.
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. 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.
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.
An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.
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.
Provides information about why a data repository task failed. Only populated when the task Lifecycle is set to FAILED.
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.
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.
The configuration for an NFS data repository association (DRA) created during the creation of the Amazon File Cache resource.
module FileCacheDataRepositoryAssociation =
Awso_fsx.Values.FileCacheDataRepositoryAssociationThe 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.
module CreateFileCacheDataRepositoryAssociations =
Awso_fsx.Values.CreateFileCacheDataRepositoryAssociationsmodule FileCacheLustreMetadataConfiguration =
Awso_fsx.Values.FileCacheLustreMetadataConfigurationThe 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.
module CreateFileCacheLustreConfiguration =
Awso_fsx.Values.CreateFileCacheLustreConfigurationThe Amazon File Cache configuration for the cache that you are creating.
The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security groups for Linux instances in the Amazon EC2 User Guide.
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 resource with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the cache in JSON format. 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.
A cache configuration is required for this operation.
An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
One or more network settings specified in the request are invalid.
The configuration for the Amazon File Cache resource.
A structure providing details of any failures that occurred.
The response object for the Amazon File Cache resource being created in 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 resource with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the cache in JSON format. 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.
module WindowsAuditLogCreateConfiguration =
Awso_fsx.Values.WindowsAuditLogCreateConfigurationThe Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server file system.
module SelfManagedActiveDirectoryConfiguration =
Awso_fsx.Values.SelfManagedActiveDirectoryConfigurationThe 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.
module CreateFileSystemWindowsConfiguration =
Awso_fsx.Values.CreateFileSystemWindowsConfigurationThe configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.
module OpenZFSCreateRootVolumeConfiguration =
Awso_fsx.Values.OpenZFSCreateRootVolumeConfigurationThe configuration of an Amazon FSx for OpenZFS root volume.
module CreateFileSystemOpenZFSConfiguration =
Awso_fsx.Values.CreateFileSystemOpenZFSConfigurationThe Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
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.
module CreateFileSystemLustreMetadataConfiguration =
Awso_fsx.Values.CreateFileSystemLustreMetadataConfigurationThe 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.
module CreateFileSystemLustreConfiguration =
Awso_fsx.Values.CreateFileSystemLustreConfigurationThe Lustre configuration for the file system being created. The following parameters are not supported for file systems with a data repository association created with . AutoImportPolicy ExportPath ImportedFileChunkSize ImportPath
The request object for the CreateFileSystemFromBackup operation.
A file system configuration is required for this operation.
module CreateFileSystemFromBackupResponse =
Awso_fsx.Values.CreateFileSystemFromBackupResponseThe response object for the CreateFileSystemFromBackup operation.
module CreateFileSystemOntapConfiguration =
Awso_fsx.Values.CreateFileSystemOntapConfigurationThe ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
The request object used to create a new Amazon FSx file system.
The path provided for data repository import isn't valid.
The path provided for data repository export isn't valid.
The response object returned after the file system is created.
Defines the SnapLock configuration when creating an FSx for ONTAP SnapLock volume.
Specifies the configuration of the ONTAP volume that you are creating.
module CreateOpenZFSOriginSnapshotConfiguration =
Awso_fsx.Values.CreateOpenZFSOriginSnapshotConfigurationThe snapshot configuration to use when creating an Amazon FSx for OpenZFS volume from a snapshot.
Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
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.
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.
module StorageVirtualMachineRootVolumeSecurityStyle =
Awso_fsx.Values.StorageVirtualMachineRootVolumeSecurityStylemodule CreateSvmActiveDirectoryConfiguration =
Awso_fsx.Values.CreateSvmActiveDirectoryConfigurationThe configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.
module CreateStorageVirtualMachineRequest =
Awso_fsx.Values.CreateStorageVirtualMachineRequestCreates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
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.
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.
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.
Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration.
module CreateStorageVirtualMachineResponse =
Awso_fsx.Values.CreateStorageVirtualMachineResponseCreates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
No FSx for ONTAP SVMs were found based upon the supplied parameters.
A volume configuration is required for this operation.
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
No data repository associations were found based upon the supplied parameters.
(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in 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.
The request object for the DeleteBackup operation.
The response object for the DeleteBackup operation.
module DeleteDataRepositoryAssociationRequest =
Awso_fsx.Values.DeleteDataRepositoryAssociationRequestDeletes 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.
module DeleteDataRepositoryAssociationResponse =
Awso_fsx.Values.DeleteDataRepositoryAssociationResponseDeletes 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.
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.
No caches were found based upon supplied parameters.
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.
module DeleteFileSystemLustreConfiguration =
Awso_fsx.Values.DeleteFileSystemLustreConfigurationThe configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.
The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.
module DeleteFileSystemOpenZFSConfiguration =
Awso_fsx.Values.DeleteFileSystemOpenZFSConfigurationThe configuration object for the Amazon FSx for OpenZFS file system used in the DeleteFileSystem operation.
The response object for the Amazon FSx for OpenZFS file system that's being deleted in the DeleteFileSystem operation.
module DeleteFileSystemWindowsConfiguration =
Awso_fsx.Values.DeleteFileSystemWindowsConfigurationThe configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.
The request object for DeleteFileSystem operation.
The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.
The response object for the DeleteFileSystem 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.
No Amazon FSx snapshots were found based on the supplied parameters.
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.
module DeleteStorageVirtualMachineRequest =
Awso_fsx.Values.DeleteStorageVirtualMachineRequestDeletes 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.
module DeleteStorageVirtualMachineResponse =
Awso_fsx.Values.DeleteStorageVirtualMachineResponseDeletes 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.
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.
The response object for the Amazon FSx for NetApp ONTAP volume being deleted in the DeleteVolume operation.
A value that specifies whether to delete all child volumes and snapshots.
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.
The maximum number of resources to return in the response. This value must be an integer greater than zero.
The value for a 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.
The request object for the DescribeBackups operation.
Response object for the DescribeBackups operation.
module DescribeDataRepositoryAssociationsRequest =
Awso_fsx.Values.DescribeDataRepositoryAssociationsRequestReturns 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.
You have filtered the response to a data repository type that is not supported.
module DescribeDataRepositoryAssociationsResponse =
Awso_fsx.Values.DescribeDataRepositoryAssociationsResponseReturns 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.
module DescribeDataRepositoryTasksRequest =
Awso_fsx.Values.DescribeDataRepositoryTasksRequestReturns 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.
module DescribeDataRepositoryTasksResponse =
Awso_fsx.Values.DescribeDataRepositoryTasksResponseReturns 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.
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.
A description of a specific Amazon File Cache resource, which is a response object from 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.
The request object for DescribeFileSystemAliases operation.
The response object for DescribeFileSystemAliases operation.
The request object for DescribeFileSystems operation.
The response object for DescribeFileSystems operation.
module S3AccessPointAttachmentsFilterValue =
Awso_fsx.Values.S3AccessPointAttachmentsFilterValuemodule S3AccessPointAttachmentsFilterValues =
Awso_fsx.Values.S3AccessPointAttachmentsFilterValuesmodule S3AccessPointAttachmentsFilterName =
Awso_fsx.Values.S3AccessPointAttachmentsFilterNameA set of Name and Values pairs used to view a select set of S3 access point attachments.
module DescribeS3AccessPointAttachmentsRequest =
Awso_fsx.Values.DescribeS3AccessPointAttachmentsRequestDescribes one or more S3 access points attached to Amazon FSx volumes. The requester requires the following permission to perform this action: fsx:DescribeS3AccessPointAttachments
The access point specified was not found.
module DescribeS3AccessPointAttachmentsResponse =
Awso_fsx.Values.DescribeS3AccessPointAttachmentsResponseDescribes one or more S3 access points attached to Amazon FSx volumes. The requester requires the following permission to perform this action: fsx:DescribeS3AccessPointAttachments
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.
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.
A filter used to restrict the results of DescribeSnapshots calls. You can use multiple filters to return results that meet all applied filter requirements.
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.
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.
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.
module DescribeStorageVirtualMachinesRequest =
Awso_fsx.Values.DescribeStorageVirtualMachinesRequestDescribes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
module DescribeStorageVirtualMachinesResponse =
Awso_fsx.Values.DescribeStorageVirtualMachinesResponseDescribes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
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.
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
module DetachAndDeleteS3AccessPointRequest =
Awso_fsx.Values.DetachAndDeleteS3AccessPointRequestDetaches an S3 access point from an Amazon FSx volume and deletes the S3 access point. The requester requires the following permission to perform this action: fsx:DetachAndDeleteS3AccessPoint s3:DeleteAccessPoint
module DetachAndDeleteS3AccessPointResponse =
Awso_fsx.Values.DetachAndDeleteS3AccessPointResponseDetaches an S3 access point from an Amazon FSx volume and deletes the S3 access point. The requester requires the following permission to perform this action: fsx:DetachAndDeleteS3AccessPoint s3:DeleteAccessPoint
module DisassociateFileSystemAliasesRequest =
Awso_fsx.Values.DisassociateFileSystemAliasesRequestThe request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.
module DisassociateFileSystemAliasesResponse =
Awso_fsx.Values.DisassociateFileSystemAliasesResponseThe 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.
The request object for ListTagsForResource operation.
The resource specified by the Amazon Resource Name (ARN) can't be found.
The resource specified does not support tagging.
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.
The response object for ListTagsForResource operation.
module ReleaseFileSystemNfsV3LocksRequest =
Awso_fsx.Values.ReleaseFileSystemNfsV3LocksRequestReleases the file system lock from an Amazon FSx for OpenZFS file system.
module ReleaseFileSystemNfsV3LocksResponse =
Awso_fsx.Values.ReleaseFileSystemNfsV3LocksResponseReleases the file system lock from an Amazon FSx for OpenZFS file system.
Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
module SelfManagedActiveDirectoryConfigurationUpdates =
Awso_fsx.Values.SelfManagedActiveDirectoryConfigurationUpdatesSpecifies 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.
module StartMisconfiguredStateRecoveryRequest =
Awso_fsx.Values.StartMisconfiguredStateRecoveryRequestAfter 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.
module StartMisconfiguredStateRecoveryResponse =
Awso_fsx.Values.StartMisconfiguredStateRecoveryResponseAfter 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.
The request object for the TagResource operation.
The response object for the TagResource operation.
The request object for UntagResource action.
The response object for UntagResource action.
module UpdateDataRepositoryAssociationRequest =
Awso_fsx.Values.UpdateDataRepositoryAssociationRequestUpdates 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.
module UpdateDataRepositoryAssociationResponse =
Awso_fsx.Values.UpdateDataRepositoryAssociationResponseUpdates 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.
module UpdateFileCacheLustreConfiguration =
Awso_fsx.Values.UpdateFileCacheLustreConfigurationThe configuration update for an Amazon File Cache resource.
Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.
Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.
module UpdateFileSystemLustreMetadataConfiguration =
Awso_fsx.Values.UpdateFileSystemLustreMetadataConfigurationThe 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.
module UpdateFileSystemLustreConfiguration =
Awso_fsx.Values.UpdateFileSystemLustreConfigurationThe configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.
module UpdateFileSystemOntapConfiguration =
Awso_fsx.Values.UpdateFileSystemOntapConfigurationThe configuration updates for an Amazon FSx for NetApp ONTAP file system.
module UpdateFileSystemOpenZFSConfiguration =
Awso_fsx.Values.UpdateFileSystemOpenZFSConfigurationThe configuration updates for an Amazon FSx for OpenZFS file system.
module UpdateFileSystemWindowsConfiguration =
Awso_fsx.Values.UpdateFileSystemWindowsConfigurationUpdates 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.
The request object for the UpdateFileSystem operation.
The response object for the UpdateFileSystem operation.
Updates the SnapLock configuration for an existing FSx for ONTAP volume.
Used to specify changes to the ONTAP configuration for the volume you are updating.
Used to specify changes to the OpenZFS configuration for the volume that you are updating.
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. 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.
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. 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.
Updates the name of an Amazon FSx for OpenZFS snapshot.
Updates the name of an Amazon FSx for OpenZFS snapshot.
module UpdateSvmActiveDirectoryConfiguration =
Awso_fsx.Values.UpdateSvmActiveDirectoryConfigurationSpecifies 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.
module UpdateStorageVirtualMachineRequest =
Awso_fsx.Values.UpdateStorageVirtualMachineRequestUpdates an FSx for ONTAP storage virtual machine (SVM).
module UpdateStorageVirtualMachineResponse =
Awso_fsx.Values.UpdateStorageVirtualMachineResponseUpdates an FSx for ONTAP storage virtual machine (SVM).
Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.