Expand description

Data structures used by operation inputs/outputs.

Modules

See Tag

Structs

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

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

Provides information about a failed administrative action.

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.

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 automatically exports the defined changes asynchronously once your application finishes modifying the file.

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 file system as you modify objects in a linked S3 bucket.

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.

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

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.

The Lustre configuration for the file system being created.

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

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

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

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

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

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

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.

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

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

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

A description of the data repository task. You use data repository tasks to perform bulk transfer operations between your Amazon FSx file system and a linked data repository.

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

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

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.

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

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

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

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

Use to specify skipping a final backup, or to add tags to a final backup.

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.

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).

A description of a specific Amazon FSx 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.

A structure providing details of any failures that occurred when creating a file system.

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

Describes why a resource lifecycle state changed.

The configuration for the Amazon FSx for Lustre file system.

The configuration for Lustre logging used to write the enabled logging events for your file system to Amazon CloudWatch Logs.

The Lustre logging configuration used when creating or updating an Amazon FSx for Lustre file system. Lustre logging writes the enabled logging events for your file system to Amazon CloudWatch Logs.

Configuration for the FSx for NetApp ONTAP file system.

The configuration of an Amazon FSx for NetApp ONTAP volume.

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

The configuration of an Amazon FSx for OpenZFS root volume.

The configuration for the Amazon FSx for OpenZFS file system.

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

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

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

The configuration of an Amazon FSx for OpenZFS volume.

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration consists of an AutoImportPolicy that defines 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.

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.

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

The configuration that Amazon FSx uses to join the Windows File Server instance to a self-managed Microsoft Active Directory (AD) directory.

A snapshot of an Amazon FSx for OpenZFS volume.

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

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

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.

Describes the configuration of the Microsoft Active Directory (AD) directory to which the Amazon FSx for ONTAP storage virtual machine (SVM) is joined. Pleae note, account credentials are not returned in the response payload.

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.

Specifies a key-value pair for a resource tag.

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.

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

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

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

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.

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.

Updates the Microsoft Active Directory (AD) configuration of an SVM joined to an AD. Please note, account credentials are not returned in the response payload.

Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

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.

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 Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server file system.

The configuration for this Microsoft Windows file system.

Enums