Skip to content

Type definitions#

Index > FSx > Type definitions

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

ActiveDirectoryBackupAttributesTypeDef#

# ActiveDirectoryBackupAttributesTypeDef definition

class ActiveDirectoryBackupAttributesTypeDef(TypedDict):
    DomainName: NotRequired[str],
    ActiveDirectoryId: NotRequired[str],
    ResourceARN: NotRequired[str],

AdministrativeActionFailureDetailsTypeDef#

# AdministrativeActionFailureDetailsTypeDef definition

class AdministrativeActionFailureDetailsTypeDef(TypedDict):
    Message: NotRequired[str],

AggregateConfigurationTypeDef#

# AggregateConfigurationTypeDef definition

class AggregateConfigurationTypeDef(TypedDict):
    Aggregates: NotRequired[List[str]],
    TotalConstituents: NotRequired[int],

AliasTypeDef#

# AliasTypeDef definition

class AliasTypeDef(TypedDict):
    Name: NotRequired[str],
    Lifecycle: NotRequired[AliasLifecycleType],  # (1)
  1. See AliasLifecycleType

AssociateFileSystemAliasesRequestRequestTypeDef#

# AssociateFileSystemAliasesRequestRequestTypeDef definition

class AssociateFileSystemAliasesRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    Aliases: Sequence[str],
    ClientRequestToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

AutoExportPolicyTypeDef#

# AutoExportPolicyTypeDef definition

class AutoExportPolicyTypeDef(TypedDict):
    Events: NotRequired[Sequence[EventTypeType]],  # (1)
  1. See EventTypeType

AutoImportPolicyTypeDef#

# AutoImportPolicyTypeDef definition

class AutoImportPolicyTypeDef(TypedDict):
    Events: NotRequired[Sequence[EventTypeType]],  # (1)
  1. See EventTypeType

AutocommitPeriodTypeDef#

# AutocommitPeriodTypeDef definition

class AutocommitPeriodTypeDef(TypedDict):
    Type: AutocommitPeriodTypeType,  # (1)
    Value: NotRequired[int],
  1. See AutocommitPeriodTypeType

BackupFailureDetailsTypeDef#

# BackupFailureDetailsTypeDef definition

class BackupFailureDetailsTypeDef(TypedDict):
    Message: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

CancelDataRepositoryTaskRequestRequestTypeDef#

# CancelDataRepositoryTaskRequestRequestTypeDef definition

class CancelDataRepositoryTaskRequestRequestTypeDef(TypedDict):
    TaskId: str,

CompletionReportTypeDef#

# CompletionReportTypeDef definition

class CompletionReportTypeDef(TypedDict):
    Enabled: bool,
    Path: NotRequired[str],
    Format: NotRequired[ReportFormatType],  # (1)
    Scope: NotRequired[ReportScopeType],  # (2)
  1. See ReportFormatType
  2. See ReportScopeType

CopySnapshotAndUpdateVolumeRequestRequestTypeDef#

# CopySnapshotAndUpdateVolumeRequestRequestTypeDef definition

class CopySnapshotAndUpdateVolumeRequestRequestTypeDef(TypedDict):
    VolumeId: str,
    SourceSnapshotARN: str,
    ClientRequestToken: NotRequired[str],
    CopyStrategy: NotRequired[OpenZFSCopyStrategyType],  # (1)
    Options: NotRequired[Sequence[UpdateOpenZFSVolumeOptionType]],  # (2)
  1. See OpenZFSCopyStrategyType
  2. See UpdateOpenZFSVolumeOptionType

CreateAggregateConfigurationTypeDef#

# CreateAggregateConfigurationTypeDef definition

class CreateAggregateConfigurationTypeDef(TypedDict):
    Aggregates: NotRequired[Sequence[str]],
    ConstituentsPerAggregate: NotRequired[int],

FileCacheLustreMetadataConfigurationTypeDef#

# FileCacheLustreMetadataConfigurationTypeDef definition

class FileCacheLustreMetadataConfigurationTypeDef(TypedDict):
    StorageCapacity: int,

LustreLogCreateConfigurationTypeDef#

# LustreLogCreateConfigurationTypeDef definition

class LustreLogCreateConfigurationTypeDef(TypedDict):
    Level: LustreAccessAuditLogLevelType,  # (1)
    Destination: NotRequired[str],
  1. See LustreAccessAuditLogLevelType

LustreRootSquashConfigurationTypeDef#

# LustreRootSquashConfigurationTypeDef definition

class LustreRootSquashConfigurationTypeDef(TypedDict):
    RootSquash: NotRequired[str],
    NoSquashNids: NotRequired[List[str]],

DiskIopsConfigurationTypeDef#

# DiskIopsConfigurationTypeDef definition

class DiskIopsConfigurationTypeDef(TypedDict):
    Mode: NotRequired[DiskIopsConfigurationModeType],  # (1)
    Iops: NotRequired[int],
  1. See DiskIopsConfigurationModeType

SelfManagedActiveDirectoryConfigurationTypeDef#

# SelfManagedActiveDirectoryConfigurationTypeDef definition

class SelfManagedActiveDirectoryConfigurationTypeDef(TypedDict):
    DomainName: str,
    UserName: str,
    Password: str,
    DnsIps: Sequence[str],
    OrganizationalUnitDistinguishedName: NotRequired[str],
    FileSystemAdministratorsGroup: NotRequired[str],

WindowsAuditLogCreateConfigurationTypeDef#

# WindowsAuditLogCreateConfigurationTypeDef definition

class WindowsAuditLogCreateConfigurationTypeDef(TypedDict):
    FileAccessAuditLogLevel: WindowsAccessAuditLogLevelType,  # (1)
    FileShareAccessAuditLogLevel: WindowsAccessAuditLogLevelType,  # (1)
    AuditLogDestination: NotRequired[str],
  1. See WindowsAccessAuditLogLevelType
  2. See WindowsAccessAuditLogLevelType

TieringPolicyTypeDef#

# TieringPolicyTypeDef definition

class TieringPolicyTypeDef(TypedDict):
    CoolingPeriod: NotRequired[int],
    Name: NotRequired[TieringPolicyNameType],  # (1)
  1. See TieringPolicyNameType

CreateOpenZFSOriginSnapshotConfigurationTypeDef#

# CreateOpenZFSOriginSnapshotConfigurationTypeDef definition

class CreateOpenZFSOriginSnapshotConfigurationTypeDef(TypedDict):
    SnapshotARN: str,
    CopyStrategy: OpenZFSCopyStrategyType,  # (1)
  1. See OpenZFSCopyStrategyType

OpenZFSUserOrGroupQuotaTypeDef#

# OpenZFSUserOrGroupQuotaTypeDef definition

class OpenZFSUserOrGroupQuotaTypeDef(TypedDict):
    Type: OpenZFSQuotaTypeType,  # (1)
    Id: int,
    StorageCapacityQuotaGiB: int,
  1. See OpenZFSQuotaTypeType

DataRepositoryFailureDetailsTypeDef#

# DataRepositoryFailureDetailsTypeDef definition

class DataRepositoryFailureDetailsTypeDef(TypedDict):
    Message: NotRequired[str],

DataRepositoryTaskFailureDetailsTypeDef#

# DataRepositoryTaskFailureDetailsTypeDef definition

class DataRepositoryTaskFailureDetailsTypeDef(TypedDict):
    Message: NotRequired[str],

DataRepositoryTaskFilterTypeDef#

# DataRepositoryTaskFilterTypeDef definition

class DataRepositoryTaskFilterTypeDef(TypedDict):
    Name: NotRequired[DataRepositoryTaskFilterNameType],  # (1)
    Values: NotRequired[Sequence[str]],
  1. See DataRepositoryTaskFilterNameType

DataRepositoryTaskStatusTypeDef#

# DataRepositoryTaskStatusTypeDef definition

class DataRepositoryTaskStatusTypeDef(TypedDict):
    TotalCount: NotRequired[int],
    SucceededCount: NotRequired[int],
    FailedCount: NotRequired[int],
    LastUpdatedTime: NotRequired[datetime],
    ReleasedCapacity: NotRequired[int],

DeleteBackupRequestRequestTypeDef#

# DeleteBackupRequestRequestTypeDef definition

class DeleteBackupRequestRequestTypeDef(TypedDict):
    BackupId: str,
    ClientRequestToken: NotRequired[str],

DeleteDataRepositoryAssociationRequestRequestTypeDef#

# DeleteDataRepositoryAssociationRequestRequestTypeDef definition

class DeleteDataRepositoryAssociationRequestRequestTypeDef(TypedDict):
    AssociationId: str,
    ClientRequestToken: NotRequired[str],
    DeleteDataInFileSystem: NotRequired[bool],

DeleteFileCacheRequestRequestTypeDef#

# DeleteFileCacheRequestRequestTypeDef definition

class DeleteFileCacheRequestRequestTypeDef(TypedDict):
    FileCacheId: str,
    ClientRequestToken: NotRequired[str],

DeleteSnapshotRequestRequestTypeDef#

# DeleteSnapshotRequestRequestTypeDef definition

class DeleteSnapshotRequestRequestTypeDef(TypedDict):
    SnapshotId: str,
    ClientRequestToken: NotRequired[str],

DeleteStorageVirtualMachineRequestRequestTypeDef#

# DeleteStorageVirtualMachineRequestRequestTypeDef definition

class DeleteStorageVirtualMachineRequestRequestTypeDef(TypedDict):
    StorageVirtualMachineId: str,
    ClientRequestToken: NotRequired[str],

DeleteVolumeOpenZFSConfigurationTypeDef#

# DeleteVolumeOpenZFSConfigurationTypeDef definition

class DeleteVolumeOpenZFSConfigurationTypeDef(TypedDict):
    Options: NotRequired[Sequence[DeleteOpenZFSVolumeOptionType]],  # (1)
  1. See DeleteOpenZFSVolumeOptionType

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Name: NotRequired[FilterNameType],  # (1)
    Values: NotRequired[Sequence[str]],
  1. See FilterNameType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeFileCachesRequestRequestTypeDef#

# DescribeFileCachesRequestRequestTypeDef definition

class DescribeFileCachesRequestRequestTypeDef(TypedDict):
    FileCacheIds: NotRequired[Sequence[str]],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeFileSystemAliasesRequestRequestTypeDef#

# DescribeFileSystemAliasesRequestRequestTypeDef definition

class DescribeFileSystemAliasesRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    ClientRequestToken: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeFileSystemsRequestRequestTypeDef#

# DescribeFileSystemsRequestRequestTypeDef definition

class DescribeFileSystemsRequestRequestTypeDef(TypedDict):
    FileSystemIds: NotRequired[Sequence[str]],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

SnapshotFilterTypeDef#

# SnapshotFilterTypeDef definition

class SnapshotFilterTypeDef(TypedDict):
    Name: NotRequired[SnapshotFilterNameType],  # (1)
    Values: NotRequired[Sequence[str]],
  1. See SnapshotFilterNameType

StorageVirtualMachineFilterTypeDef#

# StorageVirtualMachineFilterTypeDef definition

class StorageVirtualMachineFilterTypeDef(TypedDict):
    Name: NotRequired[StorageVirtualMachineFilterNameType],  # (1)
    Values: NotRequired[Sequence[str]],
  1. See StorageVirtualMachineFilterNameType

VolumeFilterTypeDef#

# VolumeFilterTypeDef definition

class VolumeFilterTypeDef(TypedDict):
    Name: NotRequired[VolumeFilterNameType],  # (1)
    Values: NotRequired[Sequence[str]],
  1. See VolumeFilterNameType

DisassociateFileSystemAliasesRequestRequestTypeDef#

# DisassociateFileSystemAliasesRequestRequestTypeDef definition

class DisassociateFileSystemAliasesRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    Aliases: Sequence[str],
    ClientRequestToken: NotRequired[str],

DurationSinceLastAccessTypeDef#

# DurationSinceLastAccessTypeDef definition

class DurationSinceLastAccessTypeDef(TypedDict):
    Unit: NotRequired[UnitType],  # (1)
    Value: NotRequired[int],
  1. See UnitType

FileCacheFailureDetailsTypeDef#

# FileCacheFailureDetailsTypeDef definition

class FileCacheFailureDetailsTypeDef(TypedDict):
    Message: NotRequired[str],

FileCacheNFSConfigurationTypeDef#

# FileCacheNFSConfigurationTypeDef definition

class FileCacheNFSConfigurationTypeDef(TypedDict):
    Version: NfsVersionType,  # (1)
    DnsIps: NotRequired[Sequence[str]],
  1. See NfsVersionType

LustreLogConfigurationTypeDef#

# LustreLogConfigurationTypeDef definition

class LustreLogConfigurationTypeDef(TypedDict):
    Level: LustreAccessAuditLogLevelType,  # (1)
    Destination: NotRequired[str],
  1. See LustreAccessAuditLogLevelType

FileSystemEndpointTypeDef#

# FileSystemEndpointTypeDef definition

class FileSystemEndpointTypeDef(TypedDict):
    DNSName: NotRequired[str],
    IpAddresses: NotRequired[List[str]],

FileSystemFailureDetailsTypeDef#

# FileSystemFailureDetailsTypeDef definition

class FileSystemFailureDetailsTypeDef(TypedDict):
    Message: NotRequired[str],

LifecycleTransitionReasonTypeDef#

# LifecycleTransitionReasonTypeDef definition

class LifecycleTransitionReasonTypeDef(TypedDict):
    Message: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

OpenZFSClientConfigurationTypeDef#

# OpenZFSClientConfigurationTypeDef definition

class OpenZFSClientConfigurationTypeDef(TypedDict):
    Clients: str,
    Options: List[str],

OpenZFSOriginSnapshotConfigurationTypeDef#

# OpenZFSOriginSnapshotConfigurationTypeDef definition

class OpenZFSOriginSnapshotConfigurationTypeDef(TypedDict):
    SnapshotARN: NotRequired[str],
    CopyStrategy: NotRequired[OpenZFSCopyStrategyType],  # (1)
  1. See OpenZFSCopyStrategyType

ReleaseFileSystemNfsV3LocksRequestRequestTypeDef#

# ReleaseFileSystemNfsV3LocksRequestRequestTypeDef definition

class ReleaseFileSystemNfsV3LocksRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    ClientRequestToken: NotRequired[str],

RestoreVolumeFromSnapshotRequestRequestTypeDef#

# RestoreVolumeFromSnapshotRequestRequestTypeDef definition

class RestoreVolumeFromSnapshotRequestRequestTypeDef(TypedDict):
    VolumeId: str,
    SnapshotId: str,
    ClientRequestToken: NotRequired[str],
    Options: NotRequired[Sequence[RestoreOpenZFSVolumeOptionType]],  # (1)
  1. See RestoreOpenZFSVolumeOptionType

RetentionPeriodTypeDef#

# Re