logo
Expand description

Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

If you’re using the service, you’re probably looking for FsxClient and Fsx.

Structs

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

Describes a specific Amazon FSx administrative action for the current Windows or Lustre 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.

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

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

A backup of an Amazon FSx file system.

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

Cancels a data repository task.

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 request object for the CreateBackup operation.

The response object for the CreateBackup operation.

The request object for the CreateFileSystemFromBackup operation.

The response object for the CreateFileSystemFromBackup operation.

The Lustre configuration for the file system being created.

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

The response object returned after the file system is created.

The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup 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.

A description of the data repository task. You use data repository tasks to perform bulk transfer operations between your Amazon FSx file system and its 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 request object for DeleteBackup operation.

The response object for DeleteBackup operation.

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 request object for DeleteFileSystem operation.

The response object for 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.

The request object for DescribeBackups operation.

Response object for DescribeBackups operation.

The request object for DescribeFileSystemAliases operation.

The response object for DescribeFileSystemAliases operation.

The request object for DescribeFileSystems operation.

The response object for DescribeFileSystems operation.

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

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

A description of a specific Amazon FSx file system.

A structure providing details of any failures that occur when creating the file system has failed.

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

A client for the Amazon FSx API.

The request object for ListTagsForResource operation.

The response object for ListTagsForResource operation.

The configuration for the Amazon FSx for Lustre file system.

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.

The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx with your self-managed Microsoft Active Directory.

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

Specifies a key-value pair for a resource tag.

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.

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

The request object for the UpdateFileSystem operation.

The response object for the UpdateFileSystem operation.

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.

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

Errors returned by AssociateFileSystemAliases

Errors returned by CancelDataRepositoryTask

Errors returned by CopyBackup

Errors returned by CreateBackup

Errors returned by CreateDataRepositoryTask

Errors returned by CreateFileSystem

Errors returned by CreateFileSystemFromBackup

Errors returned by DeleteBackup

Errors returned by DeleteFileSystem

Errors returned by DescribeBackups

Errors returned by DescribeDataRepositoryTasks

Errors returned by DescribeFileSystemAliases

Errors returned by DescribeFileSystems

Errors returned by DisassociateFileSystemAliases

Errors returned by ListTagsForResource

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateFileSystem

Traits

Trait representing the capabilities of the Amazon FSx API. Amazon FSx clients implement this trait.