Class AmazonFSxClient

Namespace: Amazon.FSx

Assembly: AWSSDK.FSx.dll

Implementation for accessing FSx

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

public class AmazonFSxClient : AmazonServiceClient, IAmazonFSx, IAmazonService, IDisposable

Inheritance: object

AmazonFSxClient

Implements: IAmazonFSx

IAmazonService

IDisposable

Constructors

AmazonFSxClient()

Constructs AmazonFSxClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

public AmazonFSxClient()

AmazonFSxClient(AmazonFSxConfig)

Constructs AmazonFSxClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

public AmazonFSxClient(AmazonFSxConfig config)

Parameters

config AmazonFSxConfig: The AmazonFSxClient Configuration Object

AmazonFSxClient(RegionEndpoint)

Constructs AmazonFSxClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

public AmazonFSxClient(RegionEndpoint region)

Parameters

region RegionEndpoint: The region to connect.

AmazonFSxClient(AWSCredentials)

Constructs AmazonFSxClient with AWS Credentials

public AmazonFSxClient(AWSCredentials credentials)

Parameters

credentials AWSCredentials: AWS Credentials

AmazonFSxClient(AWSCredentials, AmazonFSxConfig)

Constructs AmazonFSxClient with AWS Credentials and an AmazonFSxClient Configuration object.

public AmazonFSxClient(AWSCredentials credentials, AmazonFSxConfig clientConfig)

Parameters

credentials AWSCredentials: AWS Credentials
clientConfig AmazonFSxConfig: The AmazonFSxClient Configuration Object

AmazonFSxClient(AWSCredentials, RegionEndpoint)

Constructs AmazonFSxClient with AWS Credentials

public AmazonFSxClient(AWSCredentials credentials, RegionEndpoint region)

Parameters

credentials AWSCredentials: AWS Credentials
region RegionEndpoint: The region to connect.

AmazonFSxClient(string, string)

Constructs AmazonFSxClient with AWS Access Key ID and AWS Secret Key

public AmazonFSxClient(string awsAccessKeyId, string awsSecretAccessKey)

Parameters

awsAccessKeyId string: AWS Access Key ID
awsSecretAccessKey string: AWS Secret Access Key

AmazonFSxClient(string, string, AmazonFSxConfig)

Constructs AmazonFSxClient with AWS Access Key ID, AWS Secret Key and an AmazonFSxClient Configuration object.

public AmazonFSxClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonFSxConfig clientConfig)

Parameters

awsAccessKeyId string: AWS Access Key ID
awsSecretAccessKey string: AWS Secret Access Key
clientConfig AmazonFSxConfig: The AmazonFSxClient Configuration Object

AmazonFSxClient(string, string, RegionEndpoint)

Constructs AmazonFSxClient with AWS Access Key ID and AWS Secret Key

public AmazonFSxClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)

Parameters

awsAccessKeyId string: AWS Access Key ID
awsSecretAccessKey string: AWS Secret Access Key
region RegionEndpoint: The region to connect.

AmazonFSxClient(string, string, string)

Constructs AmazonFSxClient with AWS Access Key ID and AWS Secret Key

public AmazonFSxClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)

Parameters

awsAccessKeyId string: AWS Access Key ID
awsSecretAccessKey string: AWS Secret Access Key
awsSessionToken string: AWS Session Token

AmazonFSxClient(string, string, string, AmazonFSxConfig)

Constructs AmazonFSxClient with AWS Access Key ID, AWS Secret Key and an AmazonFSxClient Configuration object.

public AmazonFSxClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonFSxConfig clientConfig)

Parameters

awsAccessKeyId string: AWS Access Key ID
awsSecretAccessKey string: AWS Secret Access Key
awsSessionToken string: AWS Session Token
clientConfig AmazonFSxConfig: The AmazonFSxClient Configuration Object

AmazonFSxClient(string, string, string, RegionEndpoint)

Constructs AmazonFSxClient with AWS Access Key ID and AWS Secret Key

public AmazonFSxClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)

Parameters

awsAccessKeyId string: AWS Access Key ID
awsSecretAccessKey string: AWS Secret Access Key
awsSessionToken string: AWS Session Token
region RegionEndpoint: The region to connect.

Properties

Paginators

Paginators for the service

public IFSxPaginatorFactory Paginators { get; }

Property Value

IFSxPaginatorFactory

ServiceMetadata

Capture metadata for the service.

protected override IServiceMetadata ServiceMetadata { get; }

Property Value

IServiceMetadata

Methods

AssociateFileSystemAliasesAsync(AssociateFileSystemAliasesRequest, CancellationToken)

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

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

public virtual Task<AssociateFileSystemAliasesResponse> AssociateFileSystemAliasesAsync(AssociateFileSystemAliasesRequest request, CancellationToken cancellationToken = default)

Parameters

request AssociateFileSystemAliasesRequest: Container for the necessary parameters to execute the AssociateFileSystemAliases service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<AssociateFileSystemAliasesResponse>: The response from the AssociateFileSystemAliases service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
InternalServerErrorException: A generic error indicating a server-side failure.

See Also: REST API Reference for AssociateFileSystemAliases Operation

CancelDataRepositoryTaskAsync(CancelDataRepositoryTaskRequest, CancellationToken)

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

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

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

public virtual Task<CancelDataRepositoryTaskResponse> CancelDataRepositoryTaskAsync(CancelDataRepositoryTaskRequest request, CancellationToken cancellationToken = default)

Parameters

request CancelDataRepositoryTaskRequest: Container for the necessary parameters to execute the CancelDataRepositoryTask service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CancelDataRepositoryTaskResponse>: The response from the CancelDataRepositoryTask service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
DataRepositoryTaskEndedException: The data repository task could not be canceled because the task has already ended.
DataRepositoryTaskNotFoundException: The data repository task or tasks you specified could not be found.
InternalServerErrorException: A generic error indicating a server-side failure.
UnsupportedOperationException: The requested operation is not supported for this resource or API.

See Also: REST API Reference for CancelDataRepositoryTask Operation

CopyBackupAsync(CopyBackupRequest, CancellationToken)

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.

public virtual Task<CopyBackupResponse> CopyBackupAsync(CopyBackupRequest request, CancellationToken cancellationToken = default)

Parameters

request CopyBackupRequest: Container for the necessary parameters to execute the CopyBackup service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CopyBackupResponse>: The response from the CopyBackup service method, as returned by FSx.

Exceptions

BackupNotFoundException: No Amazon FSx backups were found based upon the supplied parameters.
BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
IncompatibleRegionForMultiAZException: Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored.
InternalServerErrorException: A generic error indicating a server-side failure.
InvalidDestinationKmsKeyException: The Key Management Service (KMS) key of the destination backup is not valid.
InvalidRegionException: The Region provided for SourceRegion is not valid or is in a different Amazon Web Services partition.
InvalidSourceKmsKeyException: The Key Management Service (KMS) key of the source backup is not valid.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
SourceBackupUnavailableException: The request was rejected because the lifecycle status of the source backup isn't AVAILABLE.
UnsupportedOperationException: The requested operation is not supported for this resource or API.

See Also: REST API Reference for CopyBackup Operation

CopySnapshotAndUpdateVolumeAsync(CopySnapshotAndUpdateVolumeRequest, CancellationToken)

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

public virtual Task<CopySnapshotAndUpdateVolumeResponse> CopySnapshotAndUpdateVolumeAsync(CopySnapshotAndUpdateVolumeRequest request, CancellationToken cancellationToken = default)

Parameters

request CopySnapshotAndUpdateVolumeRequest: Container for the necessary parameters to execute the CopySnapshotAndUpdateVolume service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CopySnapshotAndUpdateVolumeResponse>: The response from the CopySnapshotAndUpdateVolume service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

See Also: REST API Reference for CopySnapshotAndUpdateVolume Operation

CreateBackupAsync(CreateBackupRequest, CancellationToken)

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

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

A Persistent deployment type
Are not linked to a data repository

For more information about backups, see the following:

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

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

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

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

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

public virtual Task<CreateBackupResponse> CreateBackupAsync(CreateBackupRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateBackupRequest: Container for the necessary parameters to execute the CreateBackup service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateBackupResponse>: The response from the CreateBackup service method, as returned by FSx.

Exceptions

BackupInProgressException: Another backup is already under way. Wait for completion before initiating additional backups of this file system.
BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
UnsupportedOperationException: The requested operation is not supported for this resource or API.
VolumeNotFoundException: No Amazon FSx volumes were found based upon the supplied parameters.

See Also: REST API Reference for CreateBackup Operation

CreateDataRepositoryAssociationAsync(CreateDataRepositoryAssociationRequest, CancellationToken)

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

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

note

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

public virtual Task<CreateDataRepositoryAssociationResponse> CreateDataRepositoryAssociationAsync(CreateDataRepositoryAssociationRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateDataRepositoryAssociationRequest: Container for the necessary parameters to execute the CreateDataRepositoryAssociation service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateDataRepositoryAssociationResponse>: The response from the CreateDataRepositoryAssociation service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
UnsupportedOperationException: The requested operation is not supported for this resource or API.

See Also: REST API Reference for CreateDataRepositoryAssociation Operation

CreateDataRepositoryTaskAsync(CreateDataRepositoryTaskRequest, CancellationToken)

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.

public virtual Task<CreateDataRepositoryTaskResponse> CreateDataRepositoryTaskAsync(CreateDataRepositoryTaskRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateDataRepositoryTaskRequest: Container for the necessary parameters to execute the CreateDataRepositoryTask service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateDataRepositoryTaskResponse>: The response from the CreateDataRepositoryTask service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
DataRepositoryTaskExecutingException: An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
UnsupportedOperationException: The requested operation is not supported for this resource or API.

See Also: REST API Reference for CreateDataRepositoryTask Operation

CreateFileCacheAsync(CreateFileCacheRequest, CancellationToken)

Creates a new Amazon File Cache resource.

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

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

note

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

public virtual Task<CreateFileCacheResponse> CreateFileCacheAsync(CreateFileCacheRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateFileCacheRequest: Container for the necessary parameters to execute the CreateFileCache service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateFileCacheResponse>: The response from the CreateFileCache service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
InvalidNetworkSettingsException: One or more network settings specified in the request are invalid.
InvalidPerUnitStorageThroughputException: An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
MissingFileCacheConfigurationException: A cache configuration is required for this operation.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

See Also: REST API Reference for CreateFileCache Operation

CreateFileSystemAsync(CreateFileSystemRequest, CancellationToken)

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

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

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

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

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

note

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

public virtual Task<CreateFileSystemResponse> CreateFileSystemAsync(CreateFileSystemRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateFileSystemRequest: Container for the necessary parameters to execute the CreateFileSystem service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateFileSystemResponse>: The response from the CreateFileSystem service method, as returned by FSx.

Exceptions

ActiveDirectoryErrorException: An Active Directory error.
BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
InvalidExportPathException: The path provided for data repository export isn't valid.
InvalidImportPathException: The path provided for data repository import isn't valid.
InvalidNetworkSettingsException: One or more network settings specified in the request are invalid.
InvalidPerUnitStorageThroughputException: An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
MissingFileSystemConfigurationException: A file system configuration is required for this operation.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

See Also: REST API Reference for CreateFileSystem Operation

CreateFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest, CancellationToken)

Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

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

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

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

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

note

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

public virtual Task<CreateFileSystemFromBackupResponse> CreateFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateFileSystemFromBackupRequest: Container for the necessary parameters to execute the CreateFileSystemFromBackup service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateFileSystemFromBackupResponse>: The response from the CreateFileSystemFromBackup service method, as returned by FSx.

Exceptions

ActiveDirectoryErrorException: An Active Directory error.
BackupNotFoundException: No Amazon FSx backups were found based upon the supplied parameters.
BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
InvalidNetworkSettingsException: One or more network settings specified in the request are invalid.
InvalidPerUnitStorageThroughputException: An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
MissingFileSystemConfigurationException: A file system configuration is required for this operation.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

See Also: REST API Reference for CreateFileSystemFromBackup Operation

CreateSigner()

Creates the signer for the service.

protected override AbstractAWSSigner CreateSigner()

Returns

AbstractAWSSigner

CreateSnapshotAsync(CreateSnapshotRequest, CancellationToken)

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.

public virtual Task<CreateSnapshotResponse> CreateSnapshotAsync(CreateSnapshotRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateSnapshotRequest: Container for the necessary parameters to execute the CreateSnapshot service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateSnapshotResponse>: The response from the CreateSnapshot service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
VolumeNotFoundException: No Amazon FSx volumes were found based upon the supplied parameters.

See Also: REST API Reference for CreateSnapshot Operation

CreateStorageVirtualMachineAsync(CreateStorageVirtualMachineRequest, CancellationToken)

Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

public virtual Task<CreateStorageVirtualMachineResponse> CreateStorageVirtualMachineAsync(CreateStorageVirtualMachineRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateStorageVirtualMachineRequest: Container for the necessary parameters to execute the CreateStorageVirtualMachine service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateStorageVirtualMachineResponse>: The response from the CreateStorageVirtualMachine service method, as returned by FSx.

Exceptions

ActiveDirectoryErrorException: An Active Directory error.
BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
UnsupportedOperationException: The requested operation is not supported for this resource or API.

See Also: REST API Reference for CreateStorageVirtualMachine Operation

CreateVolumeAsync(CreateVolumeRequest, CancellationToken)

Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

public virtual Task<CreateVolumeResponse> CreateVolumeAsync(CreateVolumeRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateVolumeRequest: Container for the necessary parameters to execute the CreateVolume service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateVolumeResponse>: The response from the CreateVolume service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
MissingVolumeConfigurationException: A volume configuration is required for this operation.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
StorageVirtualMachineNotFoundException: No FSx for ONTAP SVMs were found based upon the supplied parameters.
UnsupportedOperationException: The requested operation is not supported for this resource or API.

See Also: REST API Reference for CreateVolume Operation

CreateVolumeFromBackupAsync(CreateVolumeFromBackupRequest, CancellationToken)

Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.

public virtual Task<CreateVolumeFromBackupResponse> CreateVolumeFromBackupAsync(CreateVolumeFromBackupRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateVolumeFromBackupRequest: Container for the necessary parameters to execute the CreateVolumeFromBackup service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateVolumeFromBackupResponse>: The response from the CreateVolumeFromBackup service method, as returned by FSx.

Exceptions

BackupNotFoundException: No Amazon FSx backups were found based upon the supplied parameters.
BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
MissingVolumeConfigurationException: A volume configuration is required for this operation.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
StorageVirtualMachineNotFoundException: No FSx for ONTAP SVMs were found based upon the supplied parameters.

See Also: REST API Reference for CreateVolumeFromBackup Operation

CustomizeRuntimePipeline(RuntimePipeline)

Customizes the runtime pipeline.

protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)

Parameters

pipeline RuntimePipeline: Runtime pipeline for the current client.

DeleteBackupAsync(DeleteBackupRequest, CancellationToken)

Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.

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

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

public virtual Task<DeleteBackupResponse> DeleteBackupAsync(DeleteBackupRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBackupRequest: Container for the necessary parameters to execute the DeleteBackup service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBackupResponse>: The response from the DeleteBackup service method, as returned by FSx.

Exceptions

BackupBeingCopiedException: You can't delete a backup while it's being copied.
BackupInProgressException: Another backup is already under way. Wait for completion before initiating additional backups of this file system.
BackupNotFoundException: No Amazon FSx backups were found based upon the supplied parameters.
BackupRestoringException: You can't delete a backup while it's being used to restore a file system.
BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.

See Also: REST API Reference for DeleteBackup Operation

DeleteDataRepositoryAssociationAsync(DeleteDataRepositoryAssociationRequest, CancellationToken)

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

public virtual Task<DeleteDataRepositoryAssociationResponse> DeleteDataRepositoryAssociationAsync(DeleteDataRepositoryAssociationRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteDataRepositoryAssociationRequest: Container for the necessary parameters to execute the DeleteDataRepositoryAssociation service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteDataRepositoryAssociationResponse>: The response from the DeleteDataRepositoryAssociation service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
DataRepositoryAssociationNotFoundException: No data repository associations were found based upon the supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

See Also: REST API Reference for DeleteDataRepositoryAssociation Operation

DeleteFileCacheAsync(DeleteFileCacheRequest, CancellationToken)

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.

public virtual Task<DeleteFileCacheResponse> DeleteFileCacheAsync(DeleteFileCacheRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteFileCacheRequest: Container for the necessary parameters to execute the DeleteFileCache service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteFileCacheResponse>: The response from the DeleteFileCache service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileCacheNotFoundException: No caches were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

See Also: REST API Reference for DeleteFileCache Operation

DeleteFileSystemAsync(DeleteFileSystemRequest, CancellationToken)

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

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

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

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

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

note

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

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

public virtual Task<DeleteFileSystemResponse> DeleteFileSystemAsync(DeleteFileSystemRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteFileSystemRequest: Container for the necessary parameters to execute the DeleteFileSystem service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteFileSystemResponse>: The response from the DeleteFileSystem service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

See Also: REST API Reference for DeleteFileSystem Operation

DeleteSnapshotAsync(DeleteSnapshotRequest, CancellationToken)

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.

public virtual Task<DeleteSnapshotResponse> DeleteSnapshotAsync(DeleteSnapshotRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteSnapshotRequest: Container for the necessary parameters to execute the DeleteSnapshot service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteSnapshotResponse>: The response from the DeleteSnapshot service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.
SnapshotNotFoundException: No Amazon FSx snapshots were found based on the supplied parameters.

See Also: REST API Reference for DeleteSnapshot Operation

DeleteStorageVirtualMachineAsync(DeleteStorageVirtualMachineRequest, CancellationToken)

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

public virtual Task<DeleteStorageVirtualMachineResponse> DeleteStorageVirtualMachineAsync(DeleteStorageVirtualMachineRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteStorageVirtualMachineRequest: Container for the necessary parameters to execute the DeleteStorageVirtualMachine service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteStorageVirtualMachineResponse>: The response from the DeleteStorageVirtualMachine service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
StorageVirtualMachineNotFoundException: No FSx for ONTAP SVMs were found based upon the supplied parameters.

See Also: REST API Reference for DeleteStorageVirtualMachine Operation

DeleteVolumeAsync(DeleteVolumeRequest, CancellationToken)

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

public virtual Task<DeleteVolumeResponse> DeleteVolumeAsync(DeleteVolumeRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteVolumeRequest: Container for the necessary parameters to execute the DeleteVolume service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteVolumeResponse>: The response from the DeleteVolume service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
VolumeNotFoundException: No Amazon FSx volumes were found based upon the supplied parameters.

See Also: REST API Reference for DeleteVolume Operation

DescribeBackupsAsync(DescribeBackupsRequest, CancellationToken)

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

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

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

When using this operation, keep the following in mind:

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

public virtual Task<DescribeBackupsResponse> DescribeBackupsAsync(DescribeBackupsRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeBackupsRequest: Container for the necessary parameters to execute the DescribeBackups service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeBackupsResponse>: The response from the DescribeBackups service method, as returned by FSx.

Exceptions

BackupNotFoundException: No Amazon FSx backups were found based upon the supplied parameters.
BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
InternalServerErrorException: A generic error indicating a server-side failure.
VolumeNotFoundException: No Amazon FSx volumes were found based upon the supplied parameters.

See Also: REST API Reference for DescribeBackups Operation

DescribeDataRepositoryAssociationsAsync(DescribeDataRepositoryAssociationsRequest, CancellationToken)

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

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

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

public virtual Task<DescribeDataRepositoryAssociationsResponse> DescribeDataRepositoryAssociationsAsync(DescribeDataRepositoryAssociationsRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeDataRepositoryAssociationsRequest: Container for the necessary parameters to execute the DescribeDataRepositoryAssociations service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeDataRepositoryAssociationsResponse>: The response from the DescribeDataRepositoryAssociations service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
DataRepositoryAssociationNotFoundException: No data repository associations were found based upon the supplied parameters.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
InternalServerErrorException: A generic error indicating a server-side failure.
InvalidDataRepositoryTypeException: You have filtered the response to a data repository type that is not supported.

See Also: REST API Reference for DescribeDataRepositoryAssociations Operation

DescribeDataRepositoryTasksAsync(DescribeDataRepositoryTasksRequest, CancellationToken)

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

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

public virtual Task<DescribeDataRepositoryTasksResponse> DescribeDataRepositoryTasksAsync(DescribeDataRepositoryTasksRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeDataRepositoryTasksRequest: Container for the necessary parameters to execute the DescribeDataRepositoryTasks service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeDataRepositoryTasksResponse>: The response from the DescribeDataRepositoryTasks service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
DataRepositoryTaskNotFoundException: The data repository task or tasks you specified could not be found.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
InternalServerErrorException: A generic error indicating a server-side failure.

See Also: REST API Reference for DescribeDataRepositoryTasks Operation

DescribeFileCachesAsync(DescribeFileCachesRequest, CancellationToken)

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.

public virtual Task<DescribeFileCachesResponse> DescribeFileCachesAsync(DescribeFileCachesRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeFileCachesRequest: Container for the necessary parameters to execute the DescribeFileCaches service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeFileCachesResponse>: The response from the DescribeFileCaches service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileCacheNotFoundException: No caches were found based upon supplied parameters.
InternalServerErrorException: A generic error indicating a server-side failure.

See Also: REST API Reference for DescribeFileCaches Operation

DescribeFileSystemAliasesAsync(DescribeFileSystemAliasesRequest, CancellationToken)

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

public virtual Task<DescribeFileSystemAliasesResponse> DescribeFileSystemAliasesAsync(DescribeFileSystemAliasesRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeFileSystemAliasesRequest: Container for the necessary parameters to execute the DescribeFileSystemAliases service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeFileSystemAliasesResponse>: The response from the DescribeFileSystemAliases service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
InternalServerErrorException: A generic error indicating a server-side failure.

See Also: REST API Reference for DescribeFileSystemAliases Operation

DescribeFileSystemsAsync(DescribeFileSystemsRequest, CancellationToken)

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

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

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

When using this operation, keep the following in mind:

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

public virtual Task<DescribeFileSystemsResponse> DescribeFileSystemsAsync(DescribeFileSystemsRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeFileSystemsRequest: Container for the necessary parameters to execute the DescribeFileSystems service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeFileSystemsResponse>: The response from the DescribeFileSystems service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
InternalServerErrorException: A generic error indicating a server-side failure.

See Also: REST API Reference for DescribeFileSystems Operation

DescribeSharedVpcConfigurationAsync(DescribeSharedVpcConfigurationRequest, CancellationToken)

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.

public virtual Task<DescribeSharedVpcConfigurationResponse> DescribeSharedVpcConfigurationAsync(DescribeSharedVpcConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeSharedVpcConfigurationRequest: Container for the necessary parameters to execute the DescribeSharedVpcConfiguration service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeSharedVpcConfigurationResponse>: The response from the DescribeSharedVpcConfiguration service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.

See Also: REST API Reference for DescribeSharedVpcConfiguration Operation

DescribeSnapshotsAsync(DescribeSnapshotsRequest, CancellationToken)

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.

public virtual Task<DescribeSnapshotsResponse> DescribeSnapshotsAsync(DescribeSnapshotsRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeSnapshotsRequest: Container for the necessary parameters to execute the DescribeSnapshots service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeSnapshotsResponse>: The response from the DescribeSnapshots service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.
SnapshotNotFoundException: No Amazon FSx snapshots were found based on the supplied parameters.

See Also: REST API Reference for DescribeSnapshots Operation

DescribeStorageVirtualMachinesAsync(DescribeStorageVirtualMachinesRequest, CancellationToken)

Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).

public virtual Task<DescribeStorageVirtualMachinesResponse> DescribeStorageVirtualMachinesAsync(DescribeStorageVirtualMachinesRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeStorageVirtualMachinesRequest: Container for the necessary parameters to execute the DescribeStorageVirtualMachines service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeStorageVirtualMachinesResponse>: The response from the DescribeStorageVirtualMachines service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.
StorageVirtualMachineNotFoundException: No FSx for ONTAP SVMs were found based upon the supplied parameters.

See Also: REST API Reference for DescribeStorageVirtualMachines Operation

DescribeVolumesAsync(DescribeVolumesRequest, CancellationToken)

Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.

public virtual Task<DescribeVolumesResponse> DescribeVolumesAsync(DescribeVolumesRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeVolumesRequest: Container for the necessary parameters to execute the DescribeVolumes service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeVolumesResponse>: The response from the DescribeVolumes service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.
VolumeNotFoundException: No Amazon FSx volumes were found based upon the supplied parameters.

See Also: REST API Reference for DescribeVolumes Operation

DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

public Endpoint DetermineServiceOperationEndpoint(AmazonWebServiceRequest request)

Parameters

request AmazonWebServiceRequest: Request for the desired service operation.

Returns

Endpoint: The resolved endpoint for the given request.

DisassociateFileSystemAliasesAsync(DisassociateFileSystemAliasesRequest, CancellationToken)

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

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

public virtual Task<DisassociateFileSystemAliasesResponse> DisassociateFileSystemAliasesAsync(DisassociateFileSystemAliasesRequest request, CancellationToken cancellationToken = default)

Parameters

request DisassociateFileSystemAliasesRequest: Container for the necessary parameters to execute the DisassociateFileSystemAliases service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DisassociateFileSystemAliasesResponse>: The response from the DisassociateFileSystemAliases service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
InternalServerErrorException: A generic error indicating a server-side failure.

See Also: REST API Reference for DisassociateFileSystemAliases Operation

Dispose(bool)

Disposes the service client.

protected override void Dispose(bool disposing)

Parameters

disposing bool

ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists tags for Amazon FSx resources.

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

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

When using this action, keep the following in mind:

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

public virtual Task<ListTagsForResourceResponse> ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default)

Parameters

request ListTagsForResourceRequest: Container for the necessary parameters to execute the ListTagsForResource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListTagsForResourceResponse>: The response from the ListTagsForResource service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.
NotServiceResourceErrorException: The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
ResourceDoesNotSupportTaggingException: The resource specified does not support tagging.
ResourceNotFoundException: The resource specified by the Amazon Resource Name (ARN) can't be found.

See Also: REST API Reference for ListTagsForResource Operation

ReleaseFileSystemNfsV3LocksAsync(ReleaseFileSystemNfsV3LocksRequest, CancellationToken)

Releases the file system lock from an Amazon FSx for OpenZFS file system.

public virtual Task<ReleaseFileSystemNfsV3LocksResponse> ReleaseFileSystemNfsV3LocksAsync(ReleaseFileSystemNfsV3LocksRequest request, CancellationToken cancellationToken = default)

Parameters

request ReleaseFileSystemNfsV3LocksRequest: Container for the necessary parameters to execute the ReleaseFileSystemNfsV3Locks service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ReleaseFileSystemNfsV3LocksResponse>: The response from the ReleaseFileSystemNfsV3Locks service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

See Also: REST API Reference for ReleaseFileSystemNfsV3Locks Operation

RestoreVolumeFromSnapshotAsync(RestoreVolumeFromSnapshotRequest, CancellationToken)

Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.

public virtual Task<RestoreVolumeFromSnapshotResponse> RestoreVolumeFromSnapshotAsync(RestoreVolumeFromSnapshotRequest request, CancellationToken cancellationToken = default)

Parameters

request RestoreVolumeFromSnapshotRequest: Container for the necessary parameters to execute the RestoreVolumeFromSnapshot service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<RestoreVolumeFromSnapshotResponse>: The response from the RestoreVolumeFromSnapshot service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.
VolumeNotFoundException: No Amazon FSx volumes were found based upon the supplied parameters.

See Also: REST API Reference for RestoreVolumeFromSnapshot Operation

StartMisconfiguredStateRecoveryAsync(StartMisconfiguredStateRecoveryRequest, CancellationToken)

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

public virtual Task<StartMisconfiguredStateRecoveryResponse> StartMisconfiguredStateRecoveryAsync(StartMisconfiguredStateRecoveryRequest request, CancellationToken cancellationToken = default)

Parameters

request StartMisconfiguredStateRecoveryRequest: Container for the necessary parameters to execute the StartMisconfiguredStateRecovery service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<StartMisconfiguredStateRecoveryResponse>: The response from the StartMisconfiguredStateRecovery service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
InternalServerErrorException: A generic error indicating a server-side failure.

See Also: REST API Reference for StartMisconfiguredStateRecovery Operation

TagResourceAsync(TagResourceRequest, CancellationToken)

Tags an Amazon FSx resource.

public virtual Task<TagResourceResponse> TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default)

Parameters

request TagResourceRequest: Container for the necessary parameters to execute the TagResource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<TagResourceResponse>: The response from the TagResource service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.
NotServiceResourceErrorException: The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
ResourceDoesNotSupportTaggingException: The resource specified does not support tagging.
ResourceNotFoundException: The resource specified by the Amazon Resource Name (ARN) can't be found.

See Also: REST API Reference for TagResource Operation

UntagResourceAsync(UntagResourceRequest, CancellationToken)

This action removes a tag from an Amazon FSx resource.

public virtual Task<UntagResourceResponse> UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default)

Parameters

request UntagResourceRequest: Container for the necessary parameters to execute the UntagResource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UntagResourceResponse>: The response from the UntagResource service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.
NotServiceResourceErrorException: The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
ResourceDoesNotSupportTaggingException: The resource specified does not support tagging.
ResourceNotFoundException: The resource specified by the Amazon Resource Name (ARN) can't be found.

See Also: REST API Reference for UntagResource Operation

UpdateDataRepositoryAssociationAsync(UpdateDataRepositoryAssociationRequest, CancellationToken)

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

public virtual Task<UpdateDataRepositoryAssociationResponse> UpdateDataRepositoryAssociationAsync(UpdateDataRepositoryAssociationRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateDataRepositoryAssociationRequest: Container for the necessary parameters to execute the UpdateDataRepositoryAssociation service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateDataRepositoryAssociationResponse>: The response from the UpdateDataRepositoryAssociation service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
DataRepositoryAssociationNotFoundException: No data repository associations were found based upon the supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

See Also: REST API Reference for UpdateDataRepositoryAssociation Operation

UpdateFileCacheAsync(UpdateFileCacheRequest, CancellationToken)

Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.

public virtual Task<UpdateFileCacheResponse> UpdateFileCacheAsync(UpdateFileCacheRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateFileCacheRequest: Container for the necessary parameters to execute the UpdateFileCache service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateFileCacheResponse>: The response from the UpdateFileCache service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileCacheNotFoundException: No caches were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
MissingFileCacheConfigurationException: A cache configuration is required for this operation.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
UnsupportedOperationException: The requested operation is not supported for this resource or API.

See Also: REST API Reference for UpdateFileCache Operation

UpdateFileSystemAsync(UpdateFileSystemRequest, CancellationToken)

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

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

AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
StorageType
ThroughputCapacity
DiskIopsConfiguration
WeeklyMaintenanceStartTime

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

AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
LogConfiguration
LustreRootSquashConfiguration
MetadataConfiguration
PerUnitStorageThroughput
StorageCapacity
WeeklyMaintenanceStartTime

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

AddRouteTableIds
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DiskIopsConfiguration
FsxAdminPassword
HAPairs
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
ThroughputCapacityPerHAPair
WeeklyMaintenanceStartTime

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

AddRouteTableIds
AutomaticBackupRetentionDays
CopyTagsToBackups
CopyTagsToVolumes
DailyAutomaticBackupStartTime
DiskIopsConfiguration
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime

public virtual Task<UpdateFileSystemResponse> UpdateFileSystemAsync(UpdateFileSystemRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateFileSystemRequest: Container for the necessary parameters to execute the UpdateFileSystem service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateFileSystemResponse>: The response from the UpdateFileSystem service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
FileSystemNotFoundException: No Amazon FSx file systems were found based upon supplied parameters.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
InvalidNetworkSettingsException: One or more network settings specified in the request are invalid.
MissingFileSystemConfigurationException: A file system configuration is required for this operation.
ServiceLimitExceededException: An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
UnsupportedOperationException: The requested operation is not supported for this resource or API.

See Also: REST API Reference for UpdateFileSystem Operation

UpdateSharedVpcConfigurationAsync(UpdateSharedVpcConfigurationRequest, CancellationToken)

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

note

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

public virtual Task<UpdateSharedVpcConfigurationResponse> UpdateSharedVpcConfigurationAsync(UpdateSharedVpcConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateSharedVpcConfigurationRequest: Container for the necessary parameters to execute the UpdateSharedVpcConfiguration service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateSharedVpcConfigurationResponse>: The response from the UpdateSharedVpcConfiguration service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.

See Also: REST API Reference for UpdateSharedVpcConfiguration Operation

UpdateSnapshotAsync(UpdateSnapshotRequest, CancellationToken)

Updates the name of an Amazon FSx for OpenZFS snapshot.

public virtual Task<UpdateSnapshotResponse> UpdateSnapshotAsync(UpdateSnapshotRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateSnapshotRequest: Container for the necessary parameters to execute the UpdateSnapshot service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateSnapshotResponse>: The response from the UpdateSnapshot service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
InternalServerErrorException: A generic error indicating a server-side failure.
SnapshotNotFoundException: No Amazon FSx snapshots were found based on the supplied parameters.

See Also: REST API Reference for UpdateSnapshot Operation

UpdateStorageVirtualMachineAsync(UpdateStorageVirtualMachineRequest, CancellationToken)

Updates an FSx for ONTAP storage virtual machine (SVM).

public virtual Task<UpdateStorageVirtualMachineResponse> UpdateStorageVirtualMachineAsync(UpdateStorageVirtualMachineRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateStorageVirtualMachineRequest: Container for the necessary parameters to execute the UpdateStorageVirtualMachine service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateStorageVirtualMachineResponse>: The response from the UpdateStorageVirtualMachine service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
StorageVirtualMachineNotFoundException: No FSx for ONTAP SVMs were found based upon the supplied parameters.
UnsupportedOperationException: The requested operation is not supported for this resource or API.

See Also: REST API Reference for UpdateStorageVirtualMachine Operation

UpdateVolumeAsync(UpdateVolumeRequest, CancellationToken)

Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

public virtual Task<UpdateVolumeResponse> UpdateVolumeAsync(UpdateVolumeRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateVolumeRequest: Container for the necessary parameters to execute the UpdateVolume service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateVolumeResponse>: The response from the UpdateVolume service method, as returned by FSx.

Exceptions

BadRequestException: A generic error indicating a failure with a client request.
IncompatibleParameterErrorException: The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
InternalServerErrorException: A generic error indicating a server-side failure.
MissingVolumeConfigurationException: A volume configuration is required for this operation.
VolumeNotFoundException: No Amazon FSx volumes were found based upon the supplied parameters.

See Also: REST API Reference for UpdateVolume Operation

Table of Contents

Class AmazonFSxClient

Constructors

AmazonFSxClient()

AmazonFSxClient(AmazonFSxConfig)

Parameters

AmazonFSxClient(RegionEndpoint)

Parameters

AmazonFSxClient(AWSCredentials)

Parameters

AmazonFSxClient(AWSCredentials, AmazonFSxConfig)

Parameters

AmazonFSxClient(AWSCredentials, RegionEndpoint)

Parameters

AmazonFSxClient(string, string)

Parameters

AmazonFSxClient(string, string, AmazonFSxConfig)

Parameters

AmazonFSxClient(string, string, RegionEndpoint)

Parameters

AmazonFSxClient(string, string, string)

Parameters

AmazonFSxClient(string, string, string, AmazonFSxConfig)

Parameters

AmazonFSxClient(string, string, string, RegionEndpoint)

Parameters

Properties

Paginators

Property Value

ServiceMetadata

Property Value

Methods

AssociateFileSystemAliasesAsync(AssociateFileSystemAliasesRequest, CancellationToken)

Parameters

Returns

Exceptions

CancelDataRepositoryTaskAsync(CancelDataRepositoryTaskRequest, CancellationToken)

Parameters

Returns

Exceptions

CopyBackupAsync(CopyBackupRequest, CancellationToken)

Parameters

Returns

Exceptions

CopySnapshotAndUpdateVolumeAsync(CopySnapshotAndUpdateVolumeRequest, CancellationToken)

Parameters

Returns

Exceptions

CreateBackupAsync(CreateBackupRequest, CancellationToken)

Parameters

Returns

Exceptions

CreateDataRepositoryAssociationAsync(CreateDataRepositoryAssociationRequest, CancellationToken)

note

Parameters

Returns

Exceptions

CreateDataRepositoryTaskAsync(CreateDataRepositoryTaskRequest, CancellationToken)

Parameters

Returns

Exceptions

CreateFileCacheAsync(CreateFileCacheRequest, CancellationToken)

note

Parameters

Returns

Exceptions

CreateFileSystemAsync(CreateFileSystemRequest, CancellationToken)

note

Parameters

Returns

Exceptions

CreateFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest, CancellationToken)

note

Parameters

Returns

Exceptions

CreateSigner()

Returns

CreateSnapshotAsync(CreateSnapshotRequest, CancellationToken)

Parameters