FSxClient

Index > FSx > FSxClient

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

FSxClient

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

# FSxClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("fsx")

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

# Exceptions.exceptions type checking example

from types_boto3_fsx.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

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

# generate_presigned_url method definition

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

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

# associate_file_system_aliases method definition

def associate_file_system_aliases(
    self,
    *,
    FileSystemId: str,
    Aliases: Sequence[str],
    ClientRequestToken: str = ...,
) -> AssociateFileSystemAliasesResponseTypeDef:  # (1)
    ...

1. See AssociateFileSystemAliasesResponseTypeDef

# associate_file_system_aliases method usage example with argument unpacking

kwargs: AssociateFileSystemAliasesRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
    "Aliases": ...,
}

parent.associate_file_system_aliases(**kwargs)

1. See AssociateFileSystemAliasesRequestRequestTypeDef

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

# cancel_data_repository_task method definition

def cancel_data_repository_task(
    self,
    *,
    TaskId: str,
) -> CancelDataRepositoryTaskResponseTypeDef:  # (1)
    ...

1. See CancelDataRepositoryTaskResponseTypeDef

# cancel_data_repository_task method usage example with argument unpacking

kwargs: CancelDataRepositoryTaskRequestRequestTypeDef = {  # (1)
    "TaskId": ...,
}

parent.cancel_data_repository_task(**kwargs)

1. See CancelDataRepositoryTaskRequestRequestTypeDef

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

# copy_backup 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

# copy_backup method usage example with argument unpacking

kwargs: CopyBackupRequestRequestTypeDef = {  # (1)
    "SourceBackupId": ...,
}

parent.copy_backup(**kwargs)

1. See CopyBackupRequestRequestTypeDef

copy_snapshot_and_update_volume

Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system.

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

# copy_snapshot_and_update_volume method definition

def copy_snapshot_and_update_volume(
    self,
    *,
    VolumeId: str,
    SourceSnapshotARN: str,
    ClientRequestToken: str = ...,
    CopyStrategy: OpenZFSCopyStrategyType = ...,  # (1)
    Options: Sequence[UpdateOpenZFSVolumeOptionType] = ...,  # (2)
) -> CopySnapshotAndUpdateVolumeResponseTypeDef:  # (3)
    ...

1. See OpenZFSCopyStrategyType
2. See UpdateOpenZFSVolumeOptionType
3. See CopySnapshotAndUpdateVolumeResponseTypeDef

# copy_snapshot_and_update_volume method usage example with argument unpacking

kwargs: CopySnapshotAndUpdateVolumeRequestRequestTypeDef = {  # (1)
    "VolumeId": ...,
    "SourceSnapshotARN": ...,
}

parent.copy_snapshot_and_update_volume(**kwargs)

1. See CopySnapshotAndUpdateVolumeRequestRequestTypeDef

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

# create_backup method definition

def create_backup(
    self,
    *,
    FileSystemId: str = ...,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    VolumeId: str = ...,
) -> CreateBackupResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateBackupResponseTypeDef

# create_backup method usage example with argument unpacking

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

# create_data_repository_association 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

# create_data_repository_association method usage example with argument unpacking

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

# create_data_repository_task 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 = ...,
    ReleaseConfiguration: ReleaseConfigurationTypeDef = ...,  # (4)
) -> CreateDataRepositoryTaskResponseTypeDef:  # (5)
    ...

1. See DataRepositoryTaskTypeType
2. See CompletionReportTypeDef
3. See TagTypeDef
4. See ReleaseConfigurationTypeDef
5. See CreateDataRepositoryTaskResponseTypeDef

# create_data_repository_task method usage example with argument unpacking

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

# create_file_cache 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

# create_file_cache method usage example with argument unpacking

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

# create_file_system method definition

def create_file_system(
    self,
    *,
    FileSystemType: FileSystemTypeType,  # (1)
    SubnetIds: Sequence[str],
    ClientRequestToken: str = ...,
    StorageCapacity: int = ...,
    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

# create_file_system method usage example with argument unpacking

kwargs: CreateFileSystemRequestRequestTypeDef = {  # (1)
    "FileSystemType": ...,
    "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

# create_file_system_from_backup 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

# create_file_system_from_backup method usage example with argument unpacking

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

# create_snapshot method definition

def create_snapshot(
    self,
    *,
    Name: str,
    VolumeId: str,
    ClientRequestToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateSnapshotResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateSnapshotResponseTypeDef

# create_snapshot method usage example with argument unpacking

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

# create_storage_virtual_machine 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

# create_storage_virtual_machine method usage example with argument unpacking

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

# create_volume 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

# create_volume method usage example with argument unpacking

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

# create_volume_from_backup 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

# create_volume_from_backup method usage example with argument unpacking

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

# delete_backup method definition

def delete_backup(
    self,
    *,
    BackupId: str,
    ClientRequestToken: str = ...,
) -> DeleteBackupResponseTypeDef:  # (1)
    ...

1. See DeleteBackupResponseTypeDef

# delete_backup method usage example with argument unpacking

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

# delete_data_repository_association method definition

def delete_data_repository_association(
    self,
    *,
    AssociationId: str,
    ClientRequestToken: str = ...,
    DeleteDataInFileSystem: bool = ...,
) -> DeleteDataRepositoryAssociationResponseTypeDef:  # (1)
    ...

1. See DeleteDataRepositoryAssociationResponseTypeDef

# delete_data_repository_association method usage example with argument unpacking

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

# delete_file_cache method definition

def delete_file_cache(
    self,
    *,
    FileCacheId: str,
    ClientRequestToken: str = ...,
) -> DeleteFileCacheResponseTypeDef:  # (1)
    ...

1. See DeleteFileCacheResponseTypeDef

# delete_file_cache method usage example with argument unpacking

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

# delete_file_system 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

# delete_file_system method usage example with argument unpacking

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

# delete_snapshot method definition

def delete_snapshot(
    self,
    *,
    SnapshotId: str,
    ClientRequestToken: str = ...,
) -> DeleteSnapshotResponseTypeDef:  # (1)
    ...

1. See DeleteSnapshotResponseTypeDef

# delete_snapshot method usage example with argument unpacking

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

# delete_storage_virtual_machine method definition

def delete_storage_virtual_machine(
    self,
    *,
    StorageVirtualMachineId: str,
    ClientRequestToken: str = ...,
) -> DeleteStorageVirtualMachineResponseTypeDef:  # (1)
    ...

1. See DeleteStorageVirtualMachineResponseTypeDef

# delete_storage_virtual_machine method usage example with argument unpacking

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

# delete_volume 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

# delete_volume method usage example with argument unpacking

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

# describe_backups 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

# describe_backups method usage example with argument unpacking

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

# describe_data_repository_associations 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

# describe_data_repository_associations method usage example with argument unpacking

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

# describe_data_repository_tasks 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

# describe_data_repository_tasks method usage example with argument unpacking

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

# describe_file_caches method definition

def describe_file_caches(
    self,
    *,
    FileCacheIds: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeFileCachesResponseTypeDef:  # (1)
    ...

1. See DescribeFileCachesResponseTypeDef

# describe_file_caches method usage example with argument unpacking

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

# describe_file_system_aliases method definition

def describe_file_system_aliases(
    self,
    *,
    FileSystemId: str,
    ClientRequestToken: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeFileSystemAliasesResponseTypeDef:  # (1)
    ...

1. See DescribeFileSystemAliasesResponseTypeDef

# describe_file_system_aliases method usage example with argument unpacking

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

# describe_file_systems method definition

def describe_file_systems(
    self,
    *,
    FileSystemIds: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeFileSystemsResponseTypeDef:  # (1)
    ...

1. See DescribeFileSystemsResponseTypeDef

# describe_file_systems method usage example with argument unpacking

kwargs: DescribeFileSystemsRequestRequestTypeDef = {  # (1)
    "FileSystemIds": ...,
}

parent.describe_file_systems(**kwargs)

1. See DescribeFileSystemsRequestRequestTypeDef

describe_shared_vpc_configuration

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.

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

# describe_shared_vpc_configuration method definition

def describe_shared_vpc_configuration(
    self,
) -> DescribeSharedVpcConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeSharedVpcConfigurationResponseTypeDef

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

# describe_snapshots method definition

def describe_snapshots(
    self,
    *,
    SnapshotIds: Sequence[str] = ...,
    Filters: Sequence[SnapshotFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    IncludeShared: bool = ...,
) -> DescribeSnapshotsResponseTypeDef:  # (2)
    ...

1. See SnapshotFilterTypeDef
2. See DescribeSnapshotsResponseTypeDef

# describe_snapshots method usage example with argument unpacking

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

# describe_storage_virtual_machines 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

# describe_storage_virtual_machines method usage example with argument unpacking

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

# describe_volumes 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

# describe_volumes method usage example with argument unpacking

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

# disassociate_file_system_aliases method definition

def disassociate_file_system_aliases(
    self,
    *,
    FileSystemId: str,
    Aliases: Sequence[str],
    ClientRequestToken: str = ...,
) -> DisassociateFileSystemAliasesResponseTypeDef:  # (1)
    ...

1. See DisassociateFileSystemAliasesResponseTypeDef

# disassociate_file_system_aliases method usage example with argument unpacking

kwargs: DisassociateFileSystemAliasesRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
    "Aliases": ...,
}

parent.disassociate_file_system_aliases(**kwargs)

1. See DisassociateFileSystemAliasesRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

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

# release_file_system_nfs_v3_locks method definition

def release_file_system_nfs_v3_locks(
    self,
    *,
    FileSystemId: str,
    ClientRequestToken: str = ...,
) -> ReleaseFileSystemNfsV3LocksResponseTypeDef:  # (1)
    ...

1. See ReleaseFileSystemNfsV3LocksResponseTypeDef

# release_file_system_nfs_v3_locks method usage example with argument unpacking

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

# restore_volume_from_snapshot 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

# restore_volume_from_snapshot method usage example with argument unpacking

kwargs: RestoreVolumeFromSnapshotRequestRequestTypeDef = {  # (1)
    "VolumeId": ...,
    "SnapshotId": ...,
}

parent.restore_volume_from_snapshot(**kwargs)

1. See RestoreVolumeFromSnapshotRequestRequestTypeDef

start_misconfigured_state_recovery

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.

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

# start_misconfigured_state_recovery method definition

def start_misconfigured_state_recovery(
    self,
    *,
    FileSystemId: str,
    ClientRequestToken: str = ...,
) -> StartMisconfiguredStateRecoveryResponseTypeDef:  # (1)
    ...

1. See StartMisconfiguredStateRecoveryResponseTypeDef

# start_misconfigured_state_recovery method usage example with argument unpacking

kwargs: StartMisconfiguredStateRecoveryRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
}

parent.start_misconfigured_state_recovery(**kwargs)

1. See StartMisconfiguredStateRecoveryRequestRequestTypeDef

tag_resource

Tags an Amazon FSx resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

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

# update_data_repository_association 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

# update_data_repository_association method usage example with argument unpacking

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

# update_file_cache method definition

def update_file_cache(
    self,
    *,
    FileCacheId: str,
    ClientRequestToken: str = ...,
    LustreConfiguration: UpdateFileCacheLustreConfigurationTypeDef = ...,  # (1)
) -> UpdateFileCacheResponseTypeDef:  # (2)
    ...

1. See UpdateFileCacheLustreConfigurationTypeDef
2. See UpdateFileCacheResponseTypeDef

# update_file_cache method usage example with argument unpacking

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

# update_file_system 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)
    StorageType: StorageTypeType = ...,  # (5)
) -> UpdateFileSystemResponseTypeDef:  # (6)
    ...

1. See UpdateFileSystemWindowsConfigurationTypeDef
2. See UpdateFileSystemLustreConfigurationTypeDef
3. See UpdateFileSystemOntapConfigurationTypeDef
4. See UpdateFileSystemOpenZFSConfigurationTypeDef
5. See StorageTypeType
6. See UpdateFileSystemResponseTypeDef

# update_file_system method usage example with argument unpacking

kwargs: UpdateFileSystemRequestRequestTypeDef = {  # (1)
    "FileSystemId": ...,
}

parent.update_file_system(**kwargs)

1. See UpdateFileSystemRequestRequestTypeDef

update_shared_vpc_configuration

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.

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

# update_shared_vpc_configuration method definition

def update_shared_vpc_configuration(
    self,
    *,
    EnableFsxRouteTableUpdatesFromParticipantAccounts: str = ...,
    ClientRequestToken: str = ...,
) -> UpdateSharedVpcConfigurationResponseTypeDef:  # (1)
    ...

1. See UpdateSharedVpcConfigurationResponseTypeDef

# update_shared_vpc_configuration method usage example with argument unpacking

kwargs: UpdateSharedVpcConfigurationRequestRequestTypeDef = {  # (1)
    "EnableFsxRouteTableUpdatesFromParticipantAccounts": ...,
}

parent.update_shared_vpc_configuration(**kwargs)

1. See UpdateSharedVpcConfigurationRequestRequestTypeDef

update_snapshot

Updates the name of an Amazon FSx for OpenZFS snapshot.

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

# update_snapshot method definition

def update_snapshot(
    self,
    *,
    Name: str,
    SnapshotId: str,
    ClientRequestToken: str = ...,
) -> UpdateSnapshotResponseTypeDef:  # (1)
    ...

1. See UpdateSnapshotResponseTypeDef

# update_snapshot method usage example with argument unpacking

kwargs: UpdateSnapshotRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "SnapshotId": ...,
}

parent.update_snapshot(**kwargs)

1. See UpdateSnapshotRequestRequestTypeDef

update_storage_virtual_machine

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

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

# update_storage_virtual_machine method definition

def update_storage_virtual_machine(
    self,
    *,
    StorageVirtualMachineId: str,
    ActiveDirectoryConfiguration: UpdateSvmActiveDirectoryConfigurationTypeDef = ...,  # (1)
    ClientRequestToken: str = ...,
    SvmAdminPassword: str = ...,
) -> UpdateStorageVirtualMachineResponseTypeDef:  # (2)
    ...

1. See UpdateSvmActiveDirectoryConfigurationTypeDef
2. See UpdateStorageVirtualMachineResponseTypeDef

# update_storage_virtual_machine method usage example with argument unpacking

kwargs: UpdateStorageVirtualMachineRequestRequestTypeDef = {  # (1)
    "StorageVirtualMachineId": ...,
}

parent.update_storage_virtual_machine(**kwargs)

1. See UpdateStorageVirtualMachineRequestRequestTypeDef

update_volume

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

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

# update_volume method definition

def update_volume(
    self,
    *,
    VolumeId: str,
    ClientRequestToken: str = ...,
    OntapConfiguration: UpdateOntapVolumeConfigurationTypeDef = ...,  # (1)
    Name: str = ...,
    OpenZFSConfiguration: UpdateOpenZFSVolumeConfigurationTypeDef = ...,  # (2)
) -> UpdateVolumeResponseTypeDef:  # (3)
    ...

1. See UpdateOntapVolumeConfigurationTypeDef
2. See UpdateOpenZFSVolumeConfigurationTypeDef
3. See UpdateVolumeResponseTypeDef

# update_volume method usage example with argument unpacking

kwargs: UpdateVolumeRequestRequestTypeDef = {  # (1)
    "VolumeId": ...,
}

parent.update_volume(**kwargs)

1. See UpdateVolumeRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("fsx").get_paginator method with overloads.

• client.get_paginator("describe_backups") -> DescribeBackupsPaginator
• client.get_paginator("describe_file_systems") -> DescribeFileSystemsPaginator
• client.get_paginator("describe_storage_virtual_machines") -> DescribeStorageVirtualMachinesPaginator
• client.get_paginator("describe_volumes") -> DescribeVolumesPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator