Skip to content

FSxClient

Index > FSx > FSxClient

Auto-generated documentation for FSx type annotations stubs module mypy-boto3-fsx.

FSxClient

Type annotations and code completion for boto3.client("fsx"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_fsx.client import FSxClient

def get_fsx_client() -> FSxClient:
    return Session().client("fsx")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("fsx").exceptions structure.

Usage example
client = boto3.client("fsx")

try:
    do_something(client)
except (
    client.ActiveDirectoryError,
    client.BackupBeingCopied,
    client.BackupInProgress,
    client.BackupNotFound,
    client.BackupRestoring,
    client.BadRequest,
    client.ClientError,
    client.DataRepositoryAssociationNotFound,
    client.DataRepositoryTaskEnded,
    client.DataRepositoryTaskExecuting,
    client.DataRepositoryTaskNotFound,
    client.FileCacheNotFound,
    client.FileSystemNotFound,
    client.IncompatibleParameterError,
    client.IncompatibleRegionForMultiAZ,
    client.InternalServerError,
    client.InvalidDataRepositoryType,
    client.InvalidDestinationKmsKey,
    client.InvalidExportPath,
    client.InvalidImportPath,
    client.InvalidNetworkSettings,
    client.InvalidPerUnitStorageThroughput,
    client.InvalidRegion,
    client.InvalidSourceKmsKey,
    client.MissingFileCacheConfiguration,
    client.MissingFileSystemConfiguration,
    client.MissingVolumeConfiguration,
    client.NotServiceResourceError,
    client.ResourceDoesNotSupportTagging,
    client.ResourceNotFound,
    client.ServiceLimitExceeded,
    client.SnapshotNotFound,
    client.SourceBackupUnavailable,
    client.StorageVirtualMachineNotFound,
    client.UnsupportedOperation,
    client.VolumeNotFound,
) as e:
    print(e)
Type checking example
from mypy_boto3_fsx.client import Exceptions

def handle_error(exc: Exceptions.ActiveDirectoryError) -> None:
    ...

Methods

associate_file_system_aliases

Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system.

Type annotations and code completion for boto3.client("fsx").associate_file_system_aliases method. boto3 documentation

Method definition
def associate_file_system_aliases(
    self,
    *,
    FileSystemId: str,
    Aliases: Sequence[str],
    ClientRequestToken: str = ...,
) -> AssociateFileSystemAliasesResponseTypeDef:  # (1)
    ...
  1. See AssociateFileSystemAliasesResponseTypeDef
Usage example with kwargs
kwargs: AssociateFileSystemAliasesRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
    "Aliases": ...,
}

parent.associate_file_system_aliases(**kwargs)
  1. See AssociateFileSystemAliasesRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("fsx").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_data_repository_task

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state.

Type annotations and code completion for boto3.client("fsx").cancel_data_repository_task method. boto3 documentation

Method definition
def cancel_data_repository_task(
    self,
    *,
    TaskId: str,
) -> CancelDataRepositoryTaskResponseTypeDef:  # (1)
    ...
  1. See CancelDataRepositoryTaskResponseTypeDef
Usage example with kwargs
kwargs: CancelDataRepositoryTaskRequestRequestTypeDef = {  # (1)
    "TaskId": ...,
}

parent.cancel_data_repository_task(**kwargs)
  1. See CancelDataRepositoryTaskRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("fsx").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

copy_backup

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

Type annotations and code completion for boto3.client("fsx").copy_backup method. boto3 documentation

Method definition
def copy_backup(
    self,
    *,
    SourceBackupId: str,
    ClientRequestToken: str = ...,
    SourceRegion: str = ...,
    KmsKeyId: str = ...,
    CopyTags: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CopyBackupResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CopyBackupResponseTypeDef
Usage example with kwargs
kwargs: CopyBackupRequestRequestTypeDef = {  # (1)
    "SourceBackupId": ...,
}

parent.copy_backup(**kwargs)
  1. See CopyBackupRequestRequestTypeDef

create_backup

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.

Type annotations and code completion for boto3.client("fsx").create_backup method. boto3 documentation

Method definition
def create_backup(
    self,
    *,
    FileSystemId: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    VolumeId: str = ...,
) -> CreateBackupResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateBackupResponseTypeDef
Usage example with kwargs
kwargs: CreateBackupRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
}

parent.create_backup(**kwargs)
  1. See CreateBackupRequestRequestTypeDef

create_data_repository_association

Creates an Amazon FSx for Lustre data repository association (DRA).

Type annotations and code completion for boto3.client("fsx").create_data_repository_association method. boto3 documentation

Method definition
def create_data_repository_association(
    self,
    *,
    FileSystemId: str,
    DataRepositoryPath: str,
    FileSystemPath: str = ...,
    BatchImportMetaDataOnCreate: bool = ...,
    ImportedFileChunkSize: int = ...,
    S3: S3DataRepositoryConfigurationTypeDef = ...,  # (1)
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateDataRepositoryAssociationResponseTypeDef:  # (3)
    ...
  1. See S3DataRepositoryConfigurationTypeDef
  2. See TagTypeDef
  3. See CreateDataRepositoryAssociationResponseTypeDef
Usage example with kwargs
kwargs: CreateDataRepositoryAssociationRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
    "DataRepositoryPath": ...,
}

parent.create_data_repository_association(**kwargs)
  1. See CreateDataRepositoryAssociationRequestRequestTypeDef

create_data_repository_task

Creates an Amazon FSx for Lustre data repository task.

Type annotations and code completion for boto3.client("fsx").create_data_repository_task method. boto3 documentation

Method definition
def create_data_repository_task(
    self,
    *,
    Type: DataRepositoryTaskTypeType,  # (1)
    FileSystemId: str,
    Report: CompletionReportTypeDef,  # (2)
    Paths: Sequence[str] = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    CapacityToRelease: int = ...,
) -> CreateDataRepositoryTaskResponseTypeDef:  # (4)
    ...
  1. See DataRepositoryTaskTypeType
  2. See CompletionReportTypeDef
  3. See TagTypeDef
  4. See CreateDataRepositoryTaskResponseTypeDef
Usage example with kwargs
kwargs: CreateDataRepositoryTaskRequestRequestTypeDef = {  # (1)
    "Type": ...,
    "FileSystemId": ...,
    "Report": ...,
}

parent.create_data_repository_task(**kwargs)
  1. See CreateDataRepositoryTaskRequestRequestTypeDef

create_file_cache

Creates a new Amazon File Cache resource.

Type annotations and code completion for boto3.client("fsx").create_file_cache method. boto3 documentation

Method definition
def create_file_cache(
    self,
    *,
    FileCacheType: FileCacheTypeType,  # (1)
    FileCacheTypeVersion: str,
    StorageCapacity: int,
    SubnetIds: Sequence[str],
    ClientRequestToken: str = ...,
    SecurityGroupIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    CopyTagsToDataRepositoryAssociations: bool = ...,
    KmsKeyId: str = ...,
    LustreConfiguration: CreateFileCacheLustreConfigurationTypeDef = ...,  # (3)
    DataRepositoryAssociations: Sequence[FileCacheDataRepositoryAssociationTypeDef] = ...,  # (4)
) -> CreateFileCacheResponseTypeDef:  # (5)
    ...
  1. See FileCacheTypeType
  2. See TagTypeDef
  3. See CreateFileCacheLustreConfigurationTypeDef
  4. See FileCacheDataRepositoryAssociationTypeDef
  5. See CreateFileCacheResponseTypeDef
Usage example with kwargs
kwargs: CreateFileCacheRequestRequestTypeDef = {  # (1)
    "FileCacheType": ...,
    "FileCacheTypeVersion": ...,
    "StorageCapacity": ...,
    "SubnetIds": ...,
}

parent.create_file_cache(**kwargs)
  1. See CreateFileCacheRequestRequestTypeDef

create_file_system

Creates a new, empty Amazon FSx file system.

Type annotations and code completion for boto3.client("fsx").create_file_system method. boto3 documentation

Method definition
def create_file_system(
    self,
    *,
    FileSystemType: FileSystemTypeType,  # (1)
    StorageCapacity: int,
    SubnetIds: Sequence[str],
    ClientRequestToken: str = ...,
    StorageType: StorageTypeType = ...,  # (2)
    SecurityGroupIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    KmsKeyId: str = ...,
    WindowsConfiguration: CreateFileSystemWindowsConfigurationTypeDef = ...,  # (4)
    LustreConfiguration: CreateFileSystemLustreConfigurationTypeDef = ...,  # (5)
    OntapConfiguration: CreateFileSystemOntapConfigurationTypeDef = ...,  # (6)
    FileSystemTypeVersion: str = ...,
    OpenZFSConfiguration: CreateFileSystemOpenZFSConfigurationTypeDef = ...,  # (7)
) -> CreateFileSystemResponseTypeDef:  # (8)
    ...
  1. See FileSystemTypeType
  2. See StorageTypeType
  3. See TagTypeDef
  4. See CreateFileSystemWindowsConfigurationTypeDef
  5. See CreateFileSystemLustreConfigurationTypeDef
  6. See CreateFileSystemOntapConfigurationTypeDef
  7. See CreateFileSystemOpenZFSConfigurationTypeDef
  8. See CreateFileSystemResponseTypeDef
Usage example with kwargs
kwargs: CreateFileSystemRequestRequestTypeDef = {  # (1)
    "FileSystemType": ...,
    "StorageCapacity": ...,
    "SubnetIds": ...,
}

parent.create_file_system(**kwargs)
  1. See CreateFileSystemRequestRequestTypeDef

create_file_system_from_backup

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.

Type annotations and code completion for boto3.client("fsx").create_file_system_from_backup method. boto3 documentation

Method definition
def create_file_system_from_backup(
    self,
    *,
    BackupId: str,
    SubnetIds: Sequence[str],
    ClientRequestToken: str = ...,
    SecurityGroupIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    WindowsConfiguration: CreateFileSystemWindowsConfigurationTypeDef = ...,  # (2)
    LustreConfiguration: CreateFileSystemLustreConfigurationTypeDef = ...,  # (3)
    StorageType: StorageTypeType = ...,  # (4)
    KmsKeyId: str = ...,
    FileSystemTypeVersion: str = ...,
    OpenZFSConfiguration: CreateFileSystemOpenZFSConfigurationTypeDef = ...,  # (5)
    StorageCapacity: int = ...,
) -> CreateFileSystemFromBackupResponseTypeDef:  # (6)
    ...
  1. See TagTypeDef
  2. See CreateFileSystemWindowsConfigurationTypeDef
  3. See CreateFileSystemLustreConfigurationTypeDef
  4. See StorageTypeType
  5. See CreateFileSystemOpenZFSConfigurationTypeDef
  6. See CreateFileSystemFromBackupResponseTypeDef
Usage example with kwargs
kwargs: CreateFileSystemFromBackupRequestRequestTypeDef = {  # (1)
    "BackupId": ...,
    "SubnetIds": ...,
}

parent.create_file_system_from_backup(**kwargs)
  1. See CreateFileSystemFromBackupRequestRequestTypeDef

create_snapshot

Creates a snapshot of an existing Amazon FSx for OpenZFS volume.

Type annotations and code completion for boto3.client("fsx").create_snapshot method. boto3 documentation

Method definition
def create_snapshot(
    self,
    *,
    Name: str,
    VolumeId: str,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateSnapshotResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateSnapshotResponseTypeDef
Usage example with kwargs
kwargs: CreateSnapshotRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "VolumeId": ...,
}

parent.create_snapshot(**kwargs)
  1. See CreateSnapshotRequestRequestTypeDef

create_storage_virtual_machine

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

Type annotations and code completion for boto3.client("fsx").create_storage_virtual_machine method. boto3 documentation

Method definition
def create_storage_virtual_machine(
    self,
    *,
    FileSystemId: str,
    Name: str,
    ActiveDirectoryConfiguration: CreateSvmActiveDirectoryConfigurationTypeDef = ...,  # (1)
    ClientRequestToken: str = ...,
    SvmAdminPassword: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    RootVolumeSecurityStyle: StorageVirtualMachineRootVolumeSecurityStyleType = ...,  # (3)
) -> CreateStorageVirtualMachineResponseTypeDef:  # (4)
    ...
  1. See CreateSvmActiveDirectoryConfigurationTypeDef
  2. See TagTypeDef
  3. See StorageVirtualMachineRootVolumeSecurityStyleType
  4. See CreateStorageVirtualMachineResponseTypeDef
Usage example with kwargs
kwargs: CreateStorageVirtualMachineRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
    "Name": ...,
}

parent.create_storage_virtual_machine(**kwargs)
  1. See CreateStorageVirtualMachineRequestRequestTypeDef

create_volume

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

Type annotations and code completion for boto3.client("fsx").create_volume method. boto3 documentation

Method definition
def create_volume(
    self,
    *,
    VolumeType: VolumeTypeType,  # (1)
    Name: str,
    ClientRequestToken: str = ...,
    OntapConfiguration: CreateOntapVolumeConfigurationTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    OpenZFSConfiguration: CreateOpenZFSVolumeConfigurationTypeDef = ...,  # (4)
) -> CreateVolumeResponseTypeDef:  # (5)
    ...
  1. See VolumeTypeType
  2. See CreateOntapVolumeConfigurationTypeDef
  3. See TagTypeDef
  4. See CreateOpenZFSVolumeConfigurationTypeDef
  5. See CreateVolumeResponseTypeDef
Usage example with kwargs
kwargs: CreateVolumeRequestRequestTypeDef = {  # (1)
    "VolumeType": ...,
    "Name": ...,
}

parent.create_volume(**kwargs)
  1. See CreateVolumeRequestRequestTypeDef

create_volume_from_backup

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

Type annotations and code completion for boto3.client("fsx").create_volume_from_backup method. boto3 documentation

Method definition
def create_volume_from_backup(
    self,
    *,
    BackupId: str,
    Name: str,
    ClientRequestToken: str = ...,
    OntapConfiguration: CreateOntapVolumeConfigurationTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateVolumeFromBackupResponseTypeDef:  # (3)
    ...
  1. See CreateOntapVolumeConfigurationTypeDef
  2. See TagTypeDef
  3. See CreateVolumeFromBackupResponseTypeDef
Usage example with kwargs
kwargs: CreateVolumeFromBackupRequestRequestTypeDef = {  # (1)
    "BackupId": ...,
    "Name": ...,
}

parent.create_volume_from_backup(**kwargs)
  1. See CreateVolumeFromBackupRequestRequestTypeDef

delete_backup

Deletes an Amazon FSx backup.

Type annotations and code completion for boto3.client("fsx").delete_backup method. boto3 documentation

Method definition
def delete_backup(
    self,
    *,
    BackupId: str,
    ClientRequestToken: str = ...,
) -> DeleteBackupResponseTypeDef:  # (1)
    ...
  1. See DeleteBackupResponseTypeDef
Usage example with kwargs
kwargs: DeleteBackupRequestRequestTypeDef = {  # (1)
    "BackupId": ...,
}

parent.delete_backup(**kwargs)
  1. See DeleteBackupRequestRequestTypeDef

delete_data_repository_association

Deletes a data repository association on an Amazon FSx for Lustre file system.

Type annotations and code completion for boto3.client("fsx").delete_data_repository_association method. boto3 documentation

Method definition
def delete_data_repository_association(
    self,
    *,
    AssociationId: str,
    ClientRequestToken: str = ...,
    DeleteDataInFileSystem: bool = ...,
) -> DeleteDataRepositoryAssociationResponseTypeDef:  # (1)
    ...
  1. See DeleteDataRepositoryAssociationResponseTypeDef
Usage example with kwargs
kwargs: DeleteDataRepositoryAssociationRequestRequestTypeDef = {  # (1)
    "AssociationId": ...,
}

parent.delete_data_repository_association(**kwargs)
  1. See DeleteDataRepositoryAssociationRequestRequestTypeDef

delete_file_cache

Deletes an Amazon File Cache resource.

Type annotations and code completion for boto3.client("fsx").delete_file_cache method. boto3 documentation

Method definition
def delete_file_cache(
    self,
    *,
    FileCacheId: str,
    ClientRequestToken: str = ...,
) -> DeleteFileCacheResponseTypeDef:  # (1)
    ...
  1. See DeleteFileCacheResponseTypeDef
Usage example with kwargs
kwargs: DeleteFileCacheRequestRequestTypeDef = {  # (1)
    "FileCacheId": ...,
}

parent.delete_file_cache(**kwargs)
  1. See DeleteFileCacheRequestRequestTypeDef

delete_file_system

Deletes a file system.

Type annotations and code completion for boto3.client("fsx").delete_file_system method. boto3 documentation

Method definition
def delete_file_system(
    self,
    *,
    FileSystemId: str,
    ClientRequestToken: str = ...,
    WindowsConfiguration: DeleteFileSystemWindowsConfigurationTypeDef = ...,  # (1)
    LustreConfiguration: DeleteFileSystemLustreConfigurationTypeDef = ...,  # (2)
    OpenZFSConfiguration: DeleteFileSystemOpenZFSConfigurationTypeDef = ...,  # (3)
) -> DeleteFileSystemResponseTypeDef:  # (4)
    ...
  1. See DeleteFileSystemWindowsConfigurationTypeDef
  2. See DeleteFileSystemLustreConfigurationTypeDef
  3. See DeleteFileSystemOpenZFSConfigurationTypeDef
  4. See DeleteFileSystemResponseTypeDef
Usage example with kwargs
kwargs: DeleteFileSystemRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
}

parent.delete_file_system(**kwargs)
  1. See DeleteFileSystemRequestRequestTypeDef

delete_snapshot

Deletes an Amazon FSx for OpenZFS snapshot.

Type annotations and code completion for boto3.client("fsx").delete_snapshot method. boto3 documentation

Method definition
def delete_snapshot(
    self,
    *,
    SnapshotId: str,
    ClientRequestToken: str = ...,
) -> DeleteSnapshotResponseTypeDef:  # (1)
    ...
  1. See DeleteSnapshotResponseTypeDef
Usage example with kwargs
kwargs: DeleteSnapshotRequestRequestTypeDef = {  # (1)
    "SnapshotId": ...,
}

parent.delete_snapshot(**kwargs)
  1. See DeleteSnapshotRequestRequestTypeDef

delete_storage_virtual_machine

Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM).

Type annotations and code completion for boto3.client("fsx").delete_storage_virtual_machine method. boto3 documentation

Method definition
def delete_storage_virtual_machine(
    self,
    *,
    StorageVirtualMachineId: str,
    ClientRequestToken: str = ...,
) -> DeleteStorageVirtualMachineResponseTypeDef:  # (1)
    ...
  1. See DeleteStorageVirtualMachineResponseTypeDef
Usage example with kwargs
kwargs: DeleteStorageVirtualMachineRequestRequestTypeDef = {  # (1)
    "StorageVirtualMachineId": ...,
}

parent.delete_storage_virtual_machine(**kwargs)
  1. See DeleteStorageVirtualMachineRequestRequestTypeDef

delete_volume

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

Type annotations and code completion for boto3.client("fsx").delete_volume method. boto3 documentation

Method definition
def delete_volume(
    self,
    *,
    VolumeId: str,
    ClientRequestToken: str = ...,
    OntapConfiguration: DeleteVolumeOntapConfigurationTypeDef = ...,  # (1)
    OpenZFSConfiguration: DeleteVolumeOpenZFSConfigurationTypeDef = ...,  # (2)
) -> DeleteVolumeResponseTypeDef:  # (3)
    ...
  1. See DeleteVolumeOntapConfigurationTypeDef
  2. See DeleteVolumeOpenZFSConfigurationTypeDef
  3. See DeleteVolumeResponseTypeDef
Usage example with kwargs
kwargs: DeleteVolumeRequestRequestTypeDef = {  # (1)
    "VolumeId": ...,
}

parent.delete_volume(**kwargs)
  1. See DeleteVolumeRequestRequestTypeDef

describe_backups

Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup.

Type annotations and code completion for boto3.client("fsx").describe_backups method. boto3 documentation

Method definition
def describe_backups(
    self,
    *,
    BackupIds: Sequence[str] = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeBackupsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeBackupsResponseTypeDef
Usage example with kwargs
kwargs: DescribeBackupsRequestRequestTypeDef = {  # (1)
    "BackupIds": ...,
}

parent.describe_backups(**kwargs)
  1. See DescribeBackupsRequestRequestTypeDef

describe_data_repository_associations

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.

Type annotations and code completion for boto3.client("fsx").describe_data_repository_associations method. boto3 documentation

Method definition
def describe_data_repository_associations(
    self,
    *,
    AssociationIds: Sequence[str] = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeDataRepositoryAssociationsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeDataRepositoryAssociationsResponseTypeDef
Usage example with kwargs
kwargs: DescribeDataRepositoryAssociationsRequestRequestTypeDef = {  # (1)
    "AssociationIds": ...,
}

parent.describe_data_repository_associations(**kwargs)
  1. See DescribeDataRepositoryAssociationsRequestRequestTypeDef

describe_data_repository_tasks

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.

Type annotations and code completion for boto3.client("fsx").describe_data_repository_tasks method. boto3 documentation

Method definition
def describe_data_repository_tasks(
    self,
    *,
    TaskIds: Sequence[str] = ...,
    Filters: Sequence[DataRepositoryTaskFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeDataRepositoryTasksResponseTypeDef:  # (2)
    ...
  1. See DataRepositoryTaskFilterTypeDef
  2. See DescribeDataRepositoryTasksResponseTypeDef
Usage example with kwargs
kwargs: DescribeDataRepositoryTasksRequestRequestTypeDef = {  # (1)
    "TaskIds": ...,
}

parent.describe_data_repository_tasks(**kwargs)
  1. See DescribeDataRepositoryTasksRequestRequestTypeDef

describe_file_caches

Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache.

Type annotations and code completion for boto3.client("fsx").describe_file_caches method. boto3 documentation

Method definition
def describe_file_caches(
    self,
    *,
    FileCacheIds: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeFileCachesResponseTypeDef:  # (1)
    ...
  1. See DescribeFileCachesResponseTypeDef
Usage example with kwargs
kwargs: DescribeFileCachesRequestRequestTypeDef = {  # (1)
    "FileCacheIds": ...,
}

parent.describe_file_caches(**kwargs)
  1. See DescribeFileCachesRequestRequestTypeDef

describe_file_system_aliases

Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.

Type annotations and code completion for boto3.client("fsx").describe_file_system_aliases method. boto3 documentation

Method definition
def describe_file_system_aliases(
    self,
    *,
    FileSystemId: str,
    ClientRequestToken: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeFileSystemAliasesResponseTypeDef:  # (1)
    ...
  1. See DescribeFileSystemAliasesResponseTypeDef
Usage example with kwargs
kwargs: DescribeFileSystemAliasesRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
}

parent.describe_file_system_aliases(**kwargs)
  1. See DescribeFileSystemAliasesRequestRequestTypeDef

describe_file_systems

Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system.

Type annotations and code completion for boto3.client("fsx").describe_file_systems method. boto3 documentation

Method definition
def describe_file_systems(
    self,
    *,
    FileSystemIds: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeFileSystemsResponseTypeDef:  # (1)
    ...
  1. See DescribeFileSystemsResponseTypeDef
Usage example with kwargs
kwargs: DescribeFileSystemsRequestRequestTypeDef = {  # (1)
    "FileSystemIds": ...,
}

parent.describe_file_systems(**kwargs)
  1. See DescribeFileSystemsRequestRequestTypeDef

describe_snapshots

Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided.

Type annotations and code completion for boto3.client("fsx").describe_snapshots method. boto3 documentation

Method definition
def describe_snapshots(
    self,
    *,
    SnapshotIds: Sequence[str] = ...,
    Filters: Sequence[SnapshotFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeSnapshotsResponseTypeDef:  # (2)
    ...
  1. See SnapshotFilterTypeDef
  2. See DescribeSnapshotsResponseTypeDef
Usage example with kwargs
kwargs: DescribeSnapshotsRequestRequestTypeDef = {  # (1)
    "SnapshotIds": ...,
}

parent.describe_snapshots(**kwargs)
  1. See DescribeSnapshotsRequestRequestTypeDef

describe_storage_virtual_machines

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

Type annotations and code completion for boto3.client("fsx").describe_storage_virtual_machines method. boto3 documentation

Method definition
def describe_storage_virtual_machines(
    self,
    *,
    StorageVirtualMachineIds: Sequence[str] = ...,
    Filters: Sequence[StorageVirtualMachineFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeStorageVirtualMachinesResponseTypeDef:  # (2)
    ...
  1. See StorageVirtualMachineFilterTypeDef
  2. See DescribeStorageVirtualMachinesResponseTypeDef
Usage example with kwargs
kwargs: DescribeStorageVirtualMachinesRequestRequestTypeDef = {  # (1)
    "StorageVirtualMachineIds": ...,
}

parent.describe_storage_virtual_machines(**kwargs)
  1. See DescribeStorageVirtualMachinesRequestRequestTypeDef

describe_volumes

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

Type annotations and code completion for boto3.client("fsx").describe_volumes method. boto3 documentation

Method definition
def describe_volumes(
    self,
    *,
    VolumeIds: Sequence[str] = ...,
    Filters: Sequence[VolumeFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeVolumesResponseTypeDef:  # (2)
    ...
  1. See VolumeFilterTypeDef
  2. See DescribeVolumesResponseTypeDef
Usage example with kwargs
kwargs: DescribeVolumesRequestRequestTypeDef = {  # (1)
    "VolumeIds": ...,
}

parent.describe_volumes(**kwargs)
  1. See DescribeVolumesRequestRequestTypeDef

disassociate_file_system_aliases

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.

Type annotations and code completion for boto3.client("fsx").disassociate_file_system_aliases method. boto3 documentation

Method definition
def disassociate_file_system_aliases(
    self,
    *,
    FileSystemId: str,
    Aliases: Sequence[str],
    ClientRequestToken: str = ...,
) -> DisassociateFileSystemAliasesResponseTypeDef:  # (1)
    ...
  1. See DisassociateFileSystemAliasesResponseTypeDef
Usage example with kwargs
kwargs: DisassociateFileSystemAliasesRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
    "Aliases": ...,
}

parent.disassociate_file_system_aliases(**kwargs)
  1. See DisassociateFileSystemAliasesRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("fsx").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_tags_for_resource

Lists tags for Amazon FSx resources.

Type annotations and code completion for boto3.client("fsx").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

release_file_system_nfs_v3_locks

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

Type annotations and code completion for boto3.client("fsx").release_file_system_nfs_v3_locks method. boto3 documentation

Method definition
def release_file_system_nfs_v3_locks(
    self,
    *,
    FileSystemId: str,
    ClientRequestToken: str = ...,
) -> ReleaseFileSystemNfsV3LocksResponseTypeDef:  # (1)
    ...
  1. See ReleaseFileSystemNfsV3LocksResponseTypeDef
Usage example with kwargs
kwargs: ReleaseFileSystemNfsV3LocksRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
}

parent.release_file_system_nfs_v3_locks(**kwargs)
  1. See ReleaseFileSystemNfsV3LocksRequestRequestTypeDef

restore_volume_from_snapshot

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

Type annotations and code completion for boto3.client("fsx").restore_volume_from_snapshot method. boto3 documentation

Method definition
def restore_volume_from_snapshot(
    self,
    *,
    VolumeId: str,
    SnapshotId: str,
    ClientRequestToken: str = ...,
    Options: Sequence[RestoreOpenZFSVolumeOptionType] = ...,  # (1)
) -> RestoreVolumeFromSnapshotResponseTypeDef:  # (2)
    ...
  1. See RestoreOpenZFSVolumeOptionType
  2. See RestoreVolumeFromSnapshotResponseTypeDef
Usage example with kwargs
kwargs: RestoreVolumeFromSnapshotRequestRequestTypeDef = {  # (1)
    "VolumeId": ...,
    "SnapshotId": ...,
}

parent.restore_volume_from_snapshot(**kwargs)
  1. See RestoreVolumeFromSnapshotRequestRequestTypeDef

tag_resource

Tags an Amazon FSx resource.

Type annotations and code completion for boto3.client("fsx").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

This action removes a tag from an Amazon FSx resource.

Type annotations and code completion for boto3.client("fsx").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_data_repository_association

Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system.

Type annotations and code completion for boto3.client("fsx").update_data_repository_association method. boto3 documentation

Method definition
def update_data_repository_association(
    self,
    *,
    AssociationId: str,
    ClientRequestToken: str = ...,
    ImportedFileChunkSize: int = ...,
    S3: S3DataRepositoryConfigurationTypeDef = ...,  # (1)
) -> UpdateDataRepositoryAssociationResponseTypeDef:  # (2)
    ...
  1. See S3DataRepositoryConfigurationTypeDef
  2. See UpdateDataRepositoryAssociationResponseTypeDef
Usage example with kwargs
kwargs: UpdateDataRepositoryAssociationRequestRequestTypeDef = {  # (1)
    "AssociationId": ...,
}

parent.update_data_repository_association(**kwargs)
  1. See UpdateDataRepositoryAssociationRequestRequestTypeDef

update_file_cache

Updates the configuration of an existing Amazon File Cache resource.

Type annotations and code completion for boto3.client("fsx").update_file_cache method. boto3 documentation

Method definition
def update_file_cache(
    self,
    *,
    FileCacheId: str,
    ClientRequestToken: str = ...,
    LustreConfiguration: UpdateFileCacheLustreConfigurationTypeDef = ...,  # (1)
) -> UpdateFileCacheResponseTypeDef:  # (2)
    ...
  1. See UpdateFileCacheLustreConfigurationTypeDef
  2. See UpdateFileCacheResponseTypeDef
Usage example with kwargs
kwargs: UpdateFileCacheRequestRequestTypeDef = {  # (1)
    "FileCacheId": ...,
}

parent.update_file_cache(**kwargs)
  1. See UpdateFileCacheRequestRequestTypeDef

update_file_system

Use this operation to update the configuration of an existing Amazon FSx file system.

Type annotations and code completion for boto3.client("fsx").update_file_system method. boto3 documentation

Method definition
def update_file_system(
    self,
    *,
    FileSystemId: str,
    ClientRequestToken: str = ...,
    StorageCapacity: int = ...,
    WindowsConfiguration: UpdateFileSystemWindowsConfigurationTypeDef = ...,  # (1)
    LustreConfiguration: UpdateFileSystemLustreConfigurationTypeDef = ...,  # (2)
    OntapConfiguration: UpdateFileSystemOntapConfigurationTypeDef = ...,  # (3)
    OpenZFSConfiguration: UpdateFileSystemOpenZFSConfigurationTypeDef = ...,  # (4)
) -> UpdateFileSystemResponseTypeDef:  # (5)
    ...
  1. See