Skip to content

Type definitions#

Index > FSx > Type definitions

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

AutoExportPolicyUnionTypeDef#

# AutoExportPolicyUnionTypeDef definition

AutoExportPolicyUnionTypeDef = Union[
    AutoExportPolicyTypeDef,  # (1)
    AutoExportPolicyOutputTypeDef,  # (2)
]
  1. See AutoExportPolicyTypeDef
  2. See AutoExportPolicyOutputTypeDef

AutoImportPolicyUnionTypeDef#

# AutoImportPolicyUnionTypeDef definition

AutoImportPolicyUnionTypeDef = Union[
    AutoImportPolicyTypeDef,  # (1)
    AutoImportPolicyOutputTypeDef,  # (2)
]
  1. See AutoImportPolicyTypeDef
  2. See AutoImportPolicyOutputTypeDef

LustreRootSquashConfigurationUnionTypeDef#

# LustreRootSquashConfigurationUnionTypeDef definition

LustreRootSquashConfigurationUnionTypeDef = Union[
    LustreRootSquashConfigurationTypeDef,  # (1)
    LustreRootSquashConfigurationOutputTypeDef,  # (2)
]
  1. See LustreRootSquashConfigurationTypeDef
  2. See LustreRootSquashConfigurationOutputTypeDef

OpenZFSClientConfigurationUnionTypeDef#

# OpenZFSClientConfigurationUnionTypeDef definition

OpenZFSClientConfigurationUnionTypeDef = Union[
    OpenZFSClientConfigurationTypeDef,  # (1)
    OpenZFSClientConfigurationOutputTypeDef,  # (2)
]
  1. See OpenZFSClientConfigurationTypeDef
  2. See OpenZFSClientConfigurationOutputTypeDef

OpenZFSNfsExportUnionTypeDef#

# OpenZFSNfsExportUnionTypeDef definition

OpenZFSNfsExportUnionTypeDef = Union[
    OpenZFSNfsExportTypeDef,  # (1)
    OpenZFSNfsExportOutputTypeDef,  # (2)
]
  1. See OpenZFSNfsExportTypeDef
  2. See OpenZFSNfsExportOutputTypeDef

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,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

AutoExportPolicyOutputTypeDef#

# AutoExportPolicyOutputTypeDef definition

class AutoExportPolicyOutputTypeDef(TypedDict):
    Events: NotRequired[list[EventTypeType]],  # (1)
  1. See EventTypeType

AutoExportPolicyTypeDef#

# AutoExportPolicyTypeDef definition

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

AutoImportPolicyOutputTypeDef#

# AutoImportPolicyOutputTypeDef definition

class AutoImportPolicyOutputTypeDef(TypedDict):
    Events: NotRequired[list[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,

CreateFileSystemLustreMetadataConfigurationTypeDef#

# CreateFileSystemLustreMetadataConfigurationTypeDef definition

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

LustreLogCreateConfigurationTypeDef#

# LustreLogCreateConfigurationTypeDef definition

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

DiskIopsConfigurationTypeDef#

# DiskIopsConfigurationTypeDef definition

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

OpenZFSReadCacheConfigurationTypeDef#

# OpenZFSReadCacheConfigurationTypeDef definition

class OpenZFSReadCacheConfigurationTypeDef(TypedDict):
    SizingMode: NotRequired[OpenZFSReadCacheSizingModeType],  # (1)
    SizeGiB: NotRequired[int],
  1. See OpenZFSReadCacheSizingModeType

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],

FileSystemLustreMetadataConfigurationTypeDef#

# FileSystemLustreMetadataConfigurationTypeDef definition

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

LifecycleTransitionReasonTypeDef#

# LifecycleTransitionReasonTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

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

LustreRootSquashConfigurationOutputTypeDef#

# LustreRootSquashConfigurationOutputTypeDef definition

class LustreRootSquashConfigurationOutputTypeDef(TypedDict):
    RootSquash: NotRequired[str],
    NoSquashNids: NotRequired[list[str]],

LustreRootSquashConfigurationTypeDef#

# LustreRootSquashConfigurationTypeDef definition

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

OpenZFSClientConfigurationOutputTypeDef#

# OpenZFSClientConfigurationOutputTypeDef definition

class OpenZFSClientConfigurationOutputTypeDef(TypedDict):
    Clients: str,
    Options: list[str],

OpenZFSClientConfigurationTypeDef#

# OpenZFSClientConfigurationTypeDef definition

class OpenZFSClientConfigurationTypeDef(TypedDict):
    Clients: str,
    Options: Sequence[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#

# RetentionPeriodTypeDef definition

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

SelfManagedActiveDirectoryAttributesTypeDef#

# SelfManagedActiveDirectoryAttributesTypeDef definition

class SelfManagedActiveDirectoryAttributesTypeDef(TypedDict):
    DomainName: NotRequired[str],
    OrganizationalUnitDistinguishedName: NotRequired[str],
    FileSystemAdministratorsGroup: NotRequired[str],
    UserName: NotRequired[str],
    DnsIps: NotRequired[list[str]],

SelfManagedActiveDirectoryConfigurationUpdatesTypeDef#

# SelfManagedActiveDirectoryConfigurationUpdatesTypeDef definition

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

StartMisconfiguredStateRecoveryRequestRequestTypeDef#

# StartMisconfiguredStateRecoveryRequestRequestTypeDef definition

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

SvmEndpointTypeDef#

# SvmEndpointTypeDef definition

class SvmEndpointTypeDef(TypedDict):
    DNSName: NotRequired[str],
    IpAddresses: NotRequired[list[str]],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateFileCacheLustreConfigurationTypeDef#

# UpdateFileCacheLustreConfigurationTypeDef definition

class UpdateFileCacheLustreConfigurationTypeDef(TypedDict):
    WeeklyMaintenanceStartTime: NotRequired[str],

UpdateFileSystemLustreMetadataConfigurationTypeDef#

# UpdateFileSystemLustreMetadataConfigurationTypeDef definition

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

UpdateSharedVpcConfigurationRequestRequestTypeDef#

# UpdateSharedVpcConfigurationRequestRequestTypeDef definition

class UpdateSharedVpcConfigurationRequestRequestTypeDef(TypedDict):
    EnableFsxRouteTableUpdatesFromParticipantAccounts: NotRequired[str],
    ClientRequestToken: NotRequired[str],

UpdateSnapshotRequestRequestTypeDef#

# UpdateSnapshotRequestRequestTypeDef definition

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

WindowsAuditLogConfigurationTypeDef#

# WindowsAuditLogConfigurationTypeDef definition

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

AssociateFileSystemAliasesResponseTypeDef#

# AssociateFileSystemAliasesResponseTypeDef definition

class AssociateFileSystemAliasesResponseTypeDef(TypedDict):
    Aliases: list[AliasTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AliasTypeDef
  2. See ResponseMetadataTypeDef

CancelDataRepositoryTaskResponseTypeDef#

# CancelDataRepositoryTaskResponseTypeDef definition

class CancelDataRepositoryTaskResponseTypeDef(TypedDict):
    Lifecycle: DataRepositoryTaskLifecycleType,  # (1)
    TaskId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataRepositoryTaskLifecycleType
  2. See ResponseMetadataTypeDef

DeleteBackupResponseTypeDef#

# DeleteBackupResponseTypeDef definition

class DeleteBackupResponseTypeDef(TypedDict):
    BackupId: str,
    Lifecycle: BackupLifecycleType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackupLifecycleType
  2. See ResponseMetadataTypeDef

DeleteDataRepositoryAssociationResponseTypeDef#

# DeleteDataRepositoryAssociationResponseTypeDef definition

class DeleteDataRepositoryAssociationResponseTypeDef(TypedDict):
    AssociationId: str,
    Lifecycle: DataRepositoryLifecycleType,  # (1)
    DeleteDataInFileSystem: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataRepositoryLifecycleType
  2. See ResponseMetadataTypeDef

DeleteFileCacheResponseTypeDef#

# DeleteFileCacheResponseTypeDef definition

class DeleteFileCacheResponseTypeDef(TypedDict):
    FileCacheId: str,
    Lifecycle: FileCacheLifecycleType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileCacheLifecycleType
  2. See ResponseMetadataTypeDef

DeleteSnapshotResponseTypeDef#

# DeleteSnapshotResponseTypeDef definition

class DeleteSnapshotResponseTypeDef(TypedDict):
    SnapshotId: str,
    Lifecycle: SnapshotLifecycleType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SnapshotLifecycleType
  2. See ResponseMetadataTypeDef

DeleteStorageVirtualMachineResponseTypeDef#

# DeleteStorageVirtualMachineResponseTypeDef definition

class DeleteStorageVirtualMachineResponseTypeDef(TypedDict):
    StorageVirtualMachineId: str,
    Lifecycle: StorageVirtualMachineLifecycleType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StorageVirtualMachineLifecycleType
  2. See ResponseMetadataTypeDef

DescribeFileSystemAliasesResponseTypeDef#

# DescribeFileSystemAliasesResponseTypeDef definition

class DescribeFileSystemAliasesResponseTypeDef(TypedDict):
    Aliases: list[AliasTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AliasTypeDef
  2. See ResponseMetadataTypeDef

DescribeSharedVpcConfigurationResponseTypeDef#

# DescribeSharedVpcConfigurationResponseTypeDef definition

class DescribeSharedVpcConfigurationResponseTypeDef(TypedDict):
    EnableFsxRouteTableUpdatesFromParticipantAccounts: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DisassociateFileSystemAliasesResponseTypeDef#

# DisassociateFileSystemAliasesResponseTypeDef definition

class DisassociateFileSystemAliasesResponseTypeDef(TypedDict):
    Aliases: list[AliasTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AliasTypeDef
  2. See ResponseMetadataTypeDef

UpdateSharedVpcConfigurationResponseTypeDef#

# UpdateSharedVpcConfigurationResponseTypeDef definition

class UpdateSharedVpcConfigurationResponseTypeDef(TypedDict):
    EnableFsxRouteTableUpdatesFromParticipantAccounts: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

NFSDataRepositoryConfigurationTypeDef#

# NFSDataRepositoryConfigurationTypeDef definition

class NFSDataRepositoryConfigurationTypeDef(TypedDict):
    Version: NfsVersionType,  # (1)
    DnsIps: NotRequired[list[str]],
    AutoExportPolicy: NotRequired[AutoExportPolicyOutputTypeDef],  # (2)
  1. See NfsVersionType
  2. See AutoExportPolicyOutputTypeDef

S3DataRepositoryConfigurationOutputTypeDef#

# S3DataRepositoryConfigurationOutputTypeDef definition

class S3DataRepositoryConfigurationOutputTypeDef(TypedDict):
    AutoImportPolicy: NotRequired[AutoImportPolicyOutputTypeDef],  # (1)
    AutoExportPolicy: NotRequired[AutoExportPolicyOutputTypeDef],  # (2)
  1. See AutoImportPolicyOutputTypeDef
  2. See AutoExportPolicyOutputTypeDef

CopyBackupRequestRequestTypeDef#

# CopyBackupRequestRequestTypeDef definition

class CopyBackupRequestRequestTypeDef(TypedDict):
    SourceBackupId: str,
    ClientRequestToken: NotRequired[str],
    SourceRegion: NotRequired[str],
    KmsKeyId: NotRequired[str],
    CopyTags: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateBackupRequestRequestTypeDef#

# CreateBackupRequestRequestTypeDef definition

class CreateBackupRequestRequestTypeDef(TypedDict):
    FileSystemId: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    VolumeId: NotRequired[str],
  1. See TagTypeDef

CreateSnapshotRequestRequestTypeDef#

# CreateSnapshotRequestRequestTypeDef definition

class CreateSnapshotRequestRequestTypeDef(TypedDict):
    Name: str,
    VolumeId: str,
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

DeleteFileSystemLustreConfigurationTypeDef#

# DeleteFileSystemLustreConfigurationTypeDef definition

class DeleteFileSystemLustreConfigurationTypeDef(TypedDict):
    SkipFinalBackup: NotRequired[bool],
    FinalBackupTags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

DeleteFileSystemLustreResponseTypeDef#

# DeleteFileSystemLustreResponseTypeDef definition

class DeleteFileSystemLustreResponseTypeDef(TypedDict):
    FinalBackupId: NotRequired[str],
    FinalBackupTags: NotRequired[list[TagTypeDef]],  # (1)
  1. See TagTypeDef

DeleteFileSystemOpenZFSConfigurationTypeDef#

# DeleteFileSystemOpenZFSConfigurationTypeDef definition

class DeleteFileSystemOpenZFSConfigurationTypeDef(TypedDict):
    SkipFinalBackup: NotRequired[bool],
    FinalBackupTags: NotRequired[Sequence[TagTypeDef]],  # (1)
    Options: NotRequired[Sequence[DeleteFileSystemOpenZFSOptionType]],  # (2)
  1. See TagTypeDef
  2. See DeleteFileSystemOpenZFSOptionType

DeleteFileSystemOpenZFSResponseTypeDef#

# DeleteFileSystemOpenZFSResponseTypeDef definition

class DeleteFileSystemOpenZFSResponseTypeDef(TypedDict):
    FinalBackupId: NotRequired[str],
    FinalBackupTags: NotRequired[list[TagTypeDef]],  # (1)
  1. See TagTypeDef

DeleteFileSystemWindowsConfigurationTypeDef#

# DeleteFileSystemWindowsConfigurationTypeDef definition

class DeleteFileSystemWindowsConfigurationTypeDef(TypedDict):
    SkipFinalBackup: NotRequired[bool],
    FinalBackupTags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

DeleteFileSystemWindowsResponseTypeDef#

# DeleteFileSystemWindowsResponseTypeDef definition

class DeleteFileSystemWindowsResponseTypeDef(TypedDict):
    FinalBackupId: NotRequired[str],
    FinalBackupTags: NotRequired[list[TagTypeDef]],  # (1)
  1. See TagTypeDef

DeleteVolumeOntapConfigurationTypeDef#

# DeleteVolumeOntapConfigurationTypeDef definition

class DeleteVolumeOntapConfigurationTypeDef(TypedDict):
    SkipFinalBackup: NotRequired[bool],
    FinalBackupTags: NotRequired[Sequence[TagTypeDef]],  # (1)
    BypassSnaplockEnterpriseRetention: NotRequired[bool],
  1. See TagTypeDef

DeleteVolumeOntapResponseTypeDef#

# DeleteVolumeOntapResponseTypeDef definition

class DeleteVolumeOntapResponseTypeDef(TypedDict):
    FinalBackupId: NotRequired[str],
    FinalBackupTags: NotRequired[list[TagTypeDef]],  # (1)
  1. See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateFileCacheLustreConfigurationTypeDef#

# CreateFileCacheLustreConfigurationTypeDef definition

class CreateFileCacheLustreConfigurationTypeDef(TypedDict):
    PerUnitStorageThroughput: int,
    DeploymentType: FileCacheLustreDeploymentTypeType,  # (1)
    MetadataConfiguration: FileCacheLustreMetadataConfigurationTypeDef,  # (2)
    WeeklyMaintenanceStartTime: NotRequired[str],
  1. See FileCacheLustreDeploymentTypeType
  2. See FileCacheLustreMetadataConfigurationTypeDef

CreateFileSystemOntapConfigurationTypeDef#

# CreateFileSystemOntapConfigurationTypeDef definition

class CreateFileSystemOntapConfigurationTypeDef(TypedDict):
    DeploymentType: OntapDeploymentTypeType,  # (1)
    AutomaticBackupRetentionDays: NotRequired[int],
    DailyAutomaticBackupStartTime: NotRequired[str],
    EndpointIpAddressRange: NotRequired[str],
    FsxAdminPassword: NotRequired[str],
    DiskIopsConfiguration: NotRequired[DiskIopsConfigurationTypeDef],  # (2)
    PreferredSubnetId: NotRequired[str],
    RouteTableIds: NotRequired[Sequence[str]],
    ThroughputCapacity: NotRequired[int],
    WeeklyMaintenanceStartTime: NotRequired[str],
    HAPairs: NotRequired[int],
    ThroughputCapacityPerHAPair: NotRequired[int],
  1. See OntapDeploymentTypeType
  2. See DiskIopsConfigurationTypeDef

UpdateFileSystemOntapConfigurationTypeDef#

# UpdateFileSystemOntapConfigurationTypeDef definition

class UpdateFileSystemOntapConfigurationTypeDef(TypedDict):
    AutomaticBackupRetentionDays: NotRequired[int],
    DailyAutomaticBackupStartTime: NotRequired[str],
    FsxAdminPassword: NotRequired[str],
    WeeklyMaintenanceStartTime: NotRequired[str],
    DiskIopsConfiguration: NotRequired[DiskIopsConfigurationTypeDef],  # (1)
    ThroughputCapacity: NotRequired[int],
    AddRouteTableIds: NotRequired[Sequence[str]],
    RemoveRouteTableIds: NotRequired[Sequence[str]],
    ThroughputCapacityPerHAPair: NotRequired[int],
    HAPairs: NotRequired[int],
  1. See DiskIopsConfigurationTypeDef

OpenZFSFileSystemConfigurationTypeDef#

# OpenZFSFileSystemConfigurationTypeDef definition

class OpenZFSFileSystemConfigurationTypeDef(TypedDict):
    AutomaticBackupRetentionDays: NotRequired[int],
    CopyTagsToBackups: NotRequired[bool],
    CopyTagsToVolumes: NotRequired[bool],
    DailyAutomaticBackupStartTime: NotRequired[str],
    DeploymentType: NotRequired[OpenZFSDeploymentTypeType],  # (1)
    ThroughputCapacity: NotRequired[int],
    WeeklyMaintenanceStartTime: NotRequired[str],
    DiskIopsConfiguration: NotRequired[DiskIopsConfigurationTypeDef],  # (2)
    RootVolumeId: NotRequired[str],
    PreferredSubnetId: NotRequired[str],
    EndpointIpAddressRange: NotRequired[str],
    RouteTableIds: NotRequired[list[str]],
    EndpointIpAddress: NotRequired[str],
    ReadCacheConfiguration: NotRequired[OpenZFSReadCacheConfigurationTypeDef],  # (3)
  1. See OpenZFSDeploymentTypeType
  2. See DiskIopsConfigurationTypeDef
  3. See OpenZFSReadCacheConfigurationTypeDef

UpdateFileSystemOpenZFSConfigurationTypeDef#

# UpdateFileSystemOpenZFSConfigurationTypeDef definition

class UpdateFileSystemOpenZFSConfigurationTypeDef(TypedDict):
    AutomaticBackupRetentionDays: NotRequired[int],
    CopyTagsToBackups: NotRequired[bool],
    CopyTagsToVolumes: NotRequired[bool],
    DailyAutomaticBackupStartTime: NotRequired[str],
    ThroughputCapacity: NotRequired[int],
    WeeklyMaintenanceStartTime: NotRequired[str],
    DiskIopsConfiguration: NotRequired[DiskIopsConfigurationTypeDef],  # (1)
    AddRouteTableIds: NotRequired[Sequence[str]],
    RemoveRouteTableIds: NotRequired[Sequence[str]],
    ReadCacheConfiguration: NotRequired[OpenZFSReadCacheConfigurationTypeDef],  # (2)
  1. See DiskIopsConfigurationTypeDef
  2. See OpenZFSReadCacheConfigurationTypeDef

CreateSvmActiveDirectoryConfigurationTypeDef#

# CreateSvmActiveDirectoryConfigurationTypeDef definition

class CreateSvmActiveDirectoryConfigurationTypeDef(TypedDict):
    NetBiosName: str,
    SelfManagedActiveDirectoryConfiguration: NotRequired[SelfManagedActiveDirectoryConfigurationTypeDef],  # (1)
  1. See SelfManagedActiveDirectoryConfigurationTypeDef

CreateFileSystemWindowsConfigurationTypeDef#

# CreateFileSystemWindowsConfigurationTypeDef definition

class CreateFileSystemWindowsConfigurationTypeDef(TypedDict):
    ThroughputCapacity: int,
    ActiveDirectoryId: NotRequired[str],
    SelfManagedActiveDirectoryConfiguration: NotRequired[SelfManagedActiveDirectoryConfigurationTypeDef],  # (1)
    DeploymentType: NotRequired[WindowsDeploymentTypeType],  # (2)
    PreferredSubnetId: NotRequired[str],
    WeeklyMaintenanceStartTime: NotRequired[str],
    DailyAutomaticBackupStartTime: NotRequired[str],
    AutomaticBackupRetentionDays: NotRequired[int],
    CopyTagsToBackups: NotRequired[bool],
    Aliases: NotRequired[Sequence[str]],
    AuditLogConfiguration: NotRequired[WindowsAuditLogCreateConfigurationTypeDef],  # (3)
    DiskIopsConfiguration: NotRequired[DiskIopsConfigurationTypeDef],  # (4)
  1. See SelfManagedActiveDirectoryConfigurationTypeDef
  2. See WindowsDeploymentTypeType
  3. See WindowsAuditLogCreateConfigurationTypeDef
  4. See DiskIopsConfigurationTypeDef

DataRepositoryConfigurationTypeDef#

# DataRepositoryConfigurationTypeDef definition

class DataRepositoryConfigurationTypeDef(TypedDict):
    Lifecycle: NotRequired[DataRepositoryLifecycleType],  # (1)
    ImportPath: NotRequired[str],
    ExportPath: NotRequired[str],
    ImportedFileChunkSize: NotRequired[int],
    AutoImportPolicy: NotRequired[AutoImportPolicyTypeType],  # (2)
    FailureDetails: NotRequired[DataRepositoryFailureDetailsTypeDef],  # (3)
  1. See DataRepositoryLifecycleType
  2. See AutoImportPolicyTypeType
  3. See DataRepositoryFailureDetailsTypeDef

DescribeDataRepositoryTasksRequestRequestTypeDef#

# DescribeDataRepositoryTasksRequestRequestTypeDef definition

class DescribeDataRepositoryTasksRequestRequestTypeDef(TypedDict):
    TaskIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[DataRepositoryTaskFilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See DataRepositoryTaskFilterTypeDef

DescribeBackupsRequestRequestTypeDef#

# DescribeBackupsRequestRequestTypeDef definition

class DescribeBackupsRequestRequestTypeDef(TypedDict):
    BackupIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See FilterTypeDef

DescribeDataRepositoryAssociationsRequestRequestTypeDef#

# DescribeDataRepositoryAssociationsRequestRequestTypeDef definition

class DescribeDataRepositoryAssociationsRequestRequestTypeDef(TypedDict):
    AssociationIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See FilterTypeDef

DescribeBackupsRequestPaginateTypeDef#

# DescribeBackupsRequestPaginateTypeDef definition

class DescribeBackupsRequestPaginateTypeDef(TypedDict):
    BackupIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeFileSystemsRequestPaginateTypeDef#

# DescribeFileSystemsRequestPaginateTypeDef definition

class DescribeFileSystemsRequestPaginateTypeDef(TypedDict):
    FileSystemIds: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceRequestPaginateTypeDef#

# ListTagsForResourceRequestPaginateTypeDef definition

class ListTagsForResourceRequestPaginateTypeDef(TypedDict):
    ResourceARN: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeSnapshotsRequestRequestTypeDef#

# DescribeSnapshotsRequestRequestTypeDef definition

class DescribeSnapshotsRequestRequestTypeDef(TypedDict):
    SnapshotIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[SnapshotFilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    IncludeShared: NotRequired[bool],
  1. See SnapshotFilterTypeDef

DescribeStorageVirtualMachinesRequestPaginateTypeDef#

# DescribeStorageVirtualMachinesRequestPaginateTypeDef definition

class DescribeStorageVirtualMachinesRequestPaginateTypeDef(TypedDict):
    StorageVirtualMachineIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[StorageVirtualMachineFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See StorageVirtualMachineFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeStorageVirtualMachinesRequestRequestTypeDef#

# DescribeStorageVirtualMachinesRequestRequestTypeDef definition

class DescribeStorageVirtualMachinesRequestRequestTypeDef(TypedDict):
    StorageVirtualMachineIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[StorageVirtualMachineFilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See StorageVirtualMachineFilterTypeDef

DescribeVolumesRequestPaginateTypeDef#

# DescribeVolumesRequestPaginateTypeDef definition

class DescribeVolumesRequestPaginateTypeDef(TypedDict):
    VolumeIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[VolumeFilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See VolumeFilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeVolumesRequestRequestTypeDef#

# DescribeVolumesRequestRequestTypeDef definition

class DescribeVolumesRequestRequestTypeDef(TypedDict):
    VolumeIds: NotRequired[Sequence[str]],
    Filters: NotRequired[Sequence[VolumeFilterTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See VolumeFilterTypeDef

ReleaseConfigurationTypeDef#

# ReleaseConfigurationTypeDef definition

class ReleaseConfigurationTypeDef(TypedDict):
    DurationSinceLastAccess: NotRequired[DurationSinceLastAccessTypeDef],  # (1)
  1. See DurationSinceLastAccessTypeDef

FileCacheDataRepositoryAssociationTypeDef#

# FileCacheDataRepositoryAssociationTypeDef definition

class FileCacheDataRepositoryAssociationTypeDef(TypedDict):
    FileCachePath: str,
    DataRepositoryPath: str,
    DataRepositorySubdirectories: NotRequired[Sequence[str]],
    NFS: NotRequired[FileCacheNFSConfigurationTypeDef],  # (1)
  1. See FileCacheNFSConfigurationTypeDef

FileCacheLustreConfigurationTypeDef#

# FileCacheLustreConfigurationTypeDef definition

class FileCacheLustreConfigurationTypeDef(TypedDict):
    PerUnitStorageThroughput: NotRequired[int],
    DeploymentType: NotRequired[FileCacheLustreDeploymentTypeType],  # (1)
    MountName: NotRequired[str],
    WeeklyMaintenanceStartTime: NotRequired[str],
    MetadataConfiguration: NotRequired[FileCacheLustreMetadataConfigurationTypeDef],  # (2)
    LogConfiguration: NotRequired[LustreLogConfigurationTypeDef],  # (3)
  1. See FileCacheLustreDeploymentTypeType
  2. See FileCacheLustreMetadataConfigurationTypeDef
  3. See LustreLogConfigurationTypeDef

FileSystemEndpointsTypeDef#

# FileSystemEndpointsTypeDef definition

class FileSystemEndpointsTypeDef(TypedDict):
    Intercluster: NotRequired[FileSystemEndpointTypeDef],  # (1)
    Management: NotRequired[FileSystemEndpointTypeDef],  # (1)
  1. See FileSystemEndpointTypeDef
  2. See FileSystemEndpointTypeDef

SnapshotPaginatorTypeDef#

# SnapshotPaginatorTypeDef definition

class SnapshotPaginatorTypeDef(TypedDict):
    ResourceARN: NotRequired[str],
    SnapshotId: NotRequired[str],
    Name: NotRequired[str],
    VolumeId: NotRequired[str],
    CreationTime: NotRequired[datetime],
    Lifecycle: NotRequired[SnapshotLifecycleType],  # (1)
    LifecycleTransitionReason: NotRequired[LifecycleTransitionReasonTypeDef],  # (2)
    Tags: NotRequired[list[TagTypeDef]],  # (3)
    AdministrativeActions: NotRequired[list[dict[str, Any]]],
  1. See SnapshotLifecycleType
  2. See LifecycleTransitionReasonTypeDef
  3. See TagTypeDef

SnapshotTypeDef#

# SnapshotTypeDef definition

class SnapshotTypeDef(TypedDict):
    ResourceARN: NotRequired[str],
    SnapshotId: NotRequired[str],
    Name: NotRequired[str],
    VolumeId: NotRequired[str],
    CreationTime: NotRequired[datetime],
    Lifecycle: NotRequired[SnapshotLifecycleType],  # (1)
    LifecycleTransitionReason: NotRequired[LifecycleTransitionReasonTypeDef],  # (2)
    Tags: NotRequired[list[TagTypeDef]],  # (3)
    AdministrativeActions: NotRequired[list[dict[str, Any]]],
  1. See SnapshotLifecycleType
  2. See LifecycleTransitionReasonTypeDef
  3. See TagTypeDef

OpenZFSNfsExportOutputTypeDef#

# OpenZFSNfsExportOutputTypeDef definition

class OpenZFSNfsExportOutputTypeDef(TypedDict):
    ClientConfigurations: list[OpenZFSClientConfigurationOutputTypeDef],  # (1)
  1. See OpenZFSClientConfigurationOutputTypeDef

SnaplockRetentionPeriodTypeDef#

# SnaplockRetentionPeriodTypeDef definition

class SnaplockRetentionPeriodTypeDef(TypedDict):
    DefaultRetention: RetentionPeriodTypeDef,  # (1)
    MinimumRetention: RetentionPeriodTypeDef,  # (1)
    MaximumRetention: RetentionPeriodTypeDef,  # (1)
  1. See RetentionPeriodTypeDef
  2. See RetentionPeriodTypeDef
  3. See RetentionPeriodTypeDef

SvmActiveDirectoryConfigurationTypeDef#

# SvmActiveDirectoryConfigurationTypeDef definition

class SvmActiveDirectoryConfigurationTypeDef(TypedDict):
    NetBiosName: NotRequired[str],
    SelfManagedActiveDirectoryConfiguration: NotRequired[SelfManagedActiveDirectoryAttributesTypeDef],  # (1)
  1. See SelfManagedActiveDirectoryAttributesTypeDef

UpdateFileSystemWindowsConfigurationTypeDef#

# UpdateFileSystemWindowsConfigurationTypeDef definition

class UpdateFileSystemWindowsConfigurationTypeDef(TypedDict):
    WeeklyMaintenanceStartTime: NotRequired[str],
    DailyAutomaticBackupStartTime: NotRequired[str],
    AutomaticBackupRetentionDays: NotRequired[int],
    ThroughputCapacity: NotRequired[int],
    SelfManagedActiveDirectoryConfiguration: NotRequired[SelfManagedActiveDirectoryConfigurationUpdatesTypeDef],  # (1)
    AuditLogConfiguration: NotRequired[WindowsAuditLogCreateConfigurationTypeDef],  # (2)
    DiskIopsConfiguration: NotRequired[DiskIopsConfigurationTypeDef],  # (3)
  1. See SelfManagedActiveDirectoryConfigurationUpdatesTypeDef
  2. See WindowsAuditLogCreateConfigurationTypeDef
  3. See DiskIopsConfigurationTypeDef

UpdateSvmActiveDirectoryConfigurationTypeDef#

# UpdateSvmActiveDirectoryConfigurationTypeDef definition

class UpdateSvmActiveDirectoryConfigurationTypeDef(TypedDict):
    SelfManagedActiveDirectoryConfiguration: NotRequired[SelfManagedActiveDirectoryConfigurationUpdatesTypeDef],  # (1)
    NetBiosName: NotRequired[str],
  1. See SelfManagedActiveDirectoryConfigurationUpdatesTypeDef

SvmEndpointsTypeDef#

# SvmEndpointsTypeDef definition

class SvmEndpointsTypeDef(TypedDict):
    Iscsi: NotRequired[SvmEndpointTypeDef],  # (1)
    Management: NotRequired[SvmEndpointTypeDef],  # (1)
    Nfs: NotRequired[SvmEndpointTypeDef],  # (1)
    Smb: NotRequired[SvmEndpointTypeDef],  # (1)
  1. See SvmEndpointTypeDef
  2. See SvmEndpointTypeDef
  3. See SvmEndpointTypeDef
  4. See SvmEndpointTypeDef

UpdateFileCacheRequestRequestTypeDef#

# UpdateFileCacheRequestRequestTypeDef definition

class UpdateFileCacheRequestRequestTypeDef(TypedDict):
    FileCacheId: str,
    ClientRequestToken: NotRequired[str],
    LustreConfiguration: NotRequired[UpdateFileCacheLustreConfigurationTypeDef],  # (1)
  1. See UpdateFileCacheLustreConfigurationTypeDef

WindowsFileSystemConfigurationTypeDef#

# WindowsFileSystemConfigurationTypeDef definition

class WindowsFileSystemConfigurationTypeDef(TypedDict):
    ActiveDirectoryId: NotRequired[str],
    SelfManagedActiveDirectoryConfiguration: NotRequired[SelfManagedActiveDirectoryAttributesTypeDef],  # (1)
    DeploymentType: NotRequired[WindowsDeploymentTypeType],  # (2)
    RemoteAdministrationEndpoint: NotRequired[str],
    PreferredSubnetId: NotRequired[str],
    PreferredFileServerIp: NotRequired[str],
    ThroughputCapacity: NotRequired[int],
    MaintenanceOperationsInProgress: NotRequired[list[FileSystemMaintenanceOperationType]],  # (3)
    WeeklyMaintenanceStartTime: NotRequired[str],
    DailyAutomaticBackupStartTime: NotRequired[str],
    AutomaticBackupRetentionDays: NotRequired[int],
    CopyTagsToBackups: NotRequired[bool],
    Aliases: NotRequired[list[AliasTypeDef]],  # (4)
    AuditLogConfiguration: NotRequired[WindowsAuditLogConfigurationTypeDef],  # (5)
    DiskIopsConfiguration: NotRequired[DiskIopsConfigurationTypeDef],  # (6)
  1. See SelfManagedActiveDirectoryAttributesTypeDef
  2. See WindowsDeploymentTypeType
  3. See FileSystemMaintenanceOperationType
  4. See AliasTypeDef
  5. See WindowsAuditLogConfigurationTypeDef
  6. See DiskIopsConfigurationTypeDef

DataRepositoryAssociationTypeDef#

# DataRepositoryAssociationTypeDef definition

class DataRepositoryAssociationTypeDef(TypedDict):
    AssociationId: NotRequired[str],
    ResourceARN: NotRequired[str],
    FileSystemId: NotRequired[str],
    Lifecycle: NotRequired[DataRepositoryLifecycleType],  # (1)
    FailureDetails: NotRequired[DataRepositoryFailureDetailsTypeDef],  # (2)
    FileSystemPath: NotRequired[str],
    DataRepositoryPath: NotRequired[str],
    BatchImportMetaDataOnCreate: NotRequired[bool],
    ImportedFileChunkSize: NotRequired[int],
    S3: NotRequired[S3DataRepositoryConfigurationOutputTypeDef],  # (3)
    Tags: NotRequired[list[TagTypeDef]],  # (4)
    CreationTime: NotRequired[datetime],
    FileCacheId: NotRequired[str],
    FileCachePath: NotRequired[str],
    DataRepositorySubdirectories: NotRequired[list[str]],
    NFS: NotRequired[NFSDataRepositoryConfigurationTypeDef],  # (5)
  1. See DataRepositoryLifecycleType
  2. See DataRepositoryFailureDetailsTypeDef
  3. See S3DataRepositoryConfigurationOutputTypeDef
  4. See TagTypeDef
  5. See NFSDataRepositoryConfigurationTypeDef

S3DataRepositoryConfigurationTypeDef#

# S3DataRepositoryConfigurationTypeDef definition

class S3DataRepositoryConfigurationTypeDef(TypedDict):
    AutoImportPolicy: NotRequired[AutoImportPolicyUnionTypeDef],  # (1)
    AutoExportPolicy: NotRequired[AutoExportPolicyUnionTypeDef],  # (2)
  1. See AutoImportPolicyTypeDef AutoImportPolicyOutputTypeDef
  2. See AutoExportPolicyTypeDef AutoExportPolicyOutputTypeDef

DeleteFileSystemRequestRequestTypeDef#

# DeleteFileSystemRequestRequestTypeDef definition

class DeleteFileSystemRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    ClientRequestToken: NotRequired[str],
    WindowsConfiguration: NotRequired[DeleteFileSystemWindowsConfigurationTypeDef],  # (1)
    LustreConfiguration: NotRequired[DeleteFileSystemLustreConfigurationTypeDef],  # (2)
    OpenZFSConfiguration: NotRequired[DeleteFileSystemOpenZFSConfigurationTypeDef],  # (3)
  1. See DeleteFileSystemWindowsConfigurationTypeDef
  2. See DeleteFileSystemLustreConfigurationTypeDef
  3. See DeleteFileSystemOpenZFSConfigurationTypeDef

DeleteFileSystemResponseTypeDef#

# DeleteFileSystemResponseTypeDef definition

class DeleteFileSystemResponseTypeDef(TypedDict):
    FileSystemId: str,
    Lifecycle: FileSystemLifecycleType,  # (1)
    WindowsResponse: DeleteFileSystemWindowsResponseTypeDef,  # (2)
    LustreResponse: DeleteFileSystemLustreResponseTypeDef,  # (3)
    OpenZFSResponse: DeleteFileSystemOpenZFSResponseTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See FileSystemLifecycleType
  2. See DeleteFileSystemWindowsResponseTypeDef
  3. See DeleteFileSystemLustreResponseTypeDef
  4. See DeleteFileSystemOpenZFSResponseTypeDef
  5. See ResponseMetadataTypeDef

DeleteVolumeRequestRequestTypeDef#

# DeleteVolumeRequestRequestTypeDef definition

class DeleteVolumeRequestRequestTypeDef(TypedDict):
    VolumeId: str,
    ClientRequestToken: NotRequired[str],
    OntapConfiguration: NotRequired[DeleteVolumeOntapConfigurationTypeDef],  # (1)
    OpenZFSConfiguration: NotRequired[DeleteVolumeOpenZFSConfigurationTypeDef],  # (2)
  1. See DeleteVolumeOntapConfigurationTypeDef
  2. See DeleteVolumeOpenZFSConfigurationTypeDef

DeleteVolumeResponseTypeDef#

# DeleteVolumeResponseTypeDef definition

class DeleteVolumeResponseTypeDef(TypedDict):
    VolumeId: str,
    Lifecycle: VolumeLifecycleType,  # (1)
    OntapResponse: DeleteVolumeOntapResponseTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See VolumeLifecycleType
  2. See DeleteVolumeOntapResponseTypeDef
  3. See ResponseMetadataTypeDef

CreateStorageVirtualMachineRequestRequestTypeDef#

# CreateStorageVirtualMachineRequestRequestTypeDef definition

class CreateStorageVirtualMachineRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    Name: str,
    ActiveDirectoryConfiguration: NotRequired[CreateSvmActiveDirectoryConfigurationTypeDef],  # (1)
    ClientRequestToken: NotRequired[str],
    SvmAdminPassword: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    RootVolumeSecurityStyle: NotRequired[StorageVirtualMachineRootVolumeSecurityStyleType],  # (3)
  1. See CreateSvmActiveDirectoryConfigurationTypeDef
  2. See TagTypeDef
  3. See StorageVirtualMachineRootVolumeSecurityStyleType

LustreFileSystemConfigurationTypeDef#

# LustreFileSystemConfigurationTypeDef definition

class LustreFileSystemConfigurationTypeDef(TypedDict):
    WeeklyMaintenanceStartTime: NotRequired[str],
    DataRepositoryConfiguration: NotRequired[DataRepositoryConfigurationTypeDef],  # (1)
    DeploymentType: NotRequired[LustreDeploymentTypeType],  # (2)
    PerUnitStorageThroughput: NotRequired[int],
    MountName: NotRequired[str],
    DailyAutomaticBackupStartTime: NotRequired[str],
    AutomaticBackupRetentionDays: NotRequired[int],
    CopyTagsToBackups: NotRequired[bool],
    DriveCacheType: NotRequired[DriveCacheTypeType],  # (3)
    DataCompressionType: NotRequired[DataCompressionTypeType],  # (4)
    LogConfiguration: NotRequired[LustreLogConfigurationTypeDef],  # (5)
    RootSquashConfiguration: NotRequired[LustreRootSquashConfigurationOutputTypeDef],  # (6)
    MetadataConfiguration: NotRequired[FileSystemLustreMetadataConfigurationTypeDef],  # (7)
    EfaEnabled: NotRequired[bool],
  1. See DataRepositoryConfigurationTypeDef
  2. See LustreDeploymentTypeType
  3. See DriveCacheTypeType
  4. See DataCompressionTypeType
  5. See LustreLogConfigurationTypeDef
  6. See LustreRootSquashConfigurationOutputTypeDef
  7. See FileSystemLustreMetadataConfigurationTypeDef

CreateDataRepositoryTaskRequestRequestTypeDef#

# CreateDataRepositoryTaskRequestRequestTypeDef definition

class CreateDataRepositoryTaskRequestRequestTypeDef(TypedDict):
    Type: DataRepositoryTaskTypeType,  # (1)
    FileSystemId: str,
    Report: CompletionReportTypeDef,  # (2)
    Paths: NotRequired[Sequence[str]],
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    CapacityToRelease: NotRequired[int],
    ReleaseConfiguration: NotRequired[ReleaseConfigurationTypeDef],  # (4)
  1. See DataRepositoryTaskTypeType
  2. See CompletionReportTypeDef
  3. See TagTypeDef
  4. See ReleaseConfigurationTypeDef

DataRepositoryTaskTypeDef#

# DataRepositoryTaskTypeDef definition

class DataRepositoryTaskTypeDef(TypedDict):
    TaskId: str,
    Lifecycle: DataRepositoryTaskLifecycleType,  # (1)
    Type: DataRepositoryTaskTypeType,  # (2)
    CreationTime: datetime,
    StartTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    ResourceARN: NotRequired[str],
    Tags: NotRequired[list[TagTypeDef]],  # (3)
    FileSystemId: NotRequired[str],
    Paths: NotRequired[list[str]],
    FailureDetails: NotRequired[DataRepositoryTaskFailureDetailsTypeDef],  # (4)
    Status: NotRequired[DataRepositoryTaskStatusTypeDef],  # (5)
    Report: NotRequired[CompletionReportTypeDef],  # (6)
    CapacityToRelease: NotRequired[int],
    FileCacheId: NotRequired[str],
    ReleaseConfiguration: NotRequired[ReleaseConfigurationTypeDef],  # (7)
  1. See DataRepositoryTaskLifecycleType
  2. See DataRepositoryTaskTypeType
  3. See TagTypeDef
  4. See DataRepositoryTaskFailureDetailsTypeDef
  5. See DataRepositoryTaskStatusTypeDef
  6. See CompletionReportTypeDef
  7. See ReleaseConfigurationTypeDef

CreateFileCacheRequestRequestTypeDef#

# CreateFileCacheRequestRequestTypeDef definition

class CreateFileCacheRequestRequestTypeDef(TypedDict):
    FileCacheType: FileCacheTypeType,  # (1)
    FileCacheTypeVersion: str,
    StorageCapacity: int,
    SubnetIds: Sequence[str],
    ClientRequestToken: NotRequired[str],
    SecurityGroupIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    CopyTagsToDataRepositoryAssociations: NotRequired[bool],
    KmsKeyId: NotRequired[str],
    LustreConfiguration: NotRequired[CreateFileCacheLustreConfigurationTypeDef],  # (3)
    DataRepositoryAssociations: NotRequired[Sequence[FileCacheDataRepositoryAssociationTypeDef]],  # (4)
  1. See FileCacheTypeType
  2. See TagTypeDef
  3. See CreateFileCacheLustreConfigurationTypeDef
  4. See FileCacheDataRepositoryAssociationTypeDef

FileCacheCreatingTypeDef#

# FileCacheCreatingTypeDef definition

class FileCacheCreatingTypeDef(TypedDict):
    OwnerId: NotRequired[str],
    CreationTime: NotRequired[datetime],
    FileCacheId: NotRequired[str],
    FileCacheType: NotRequired[FileCacheTypeType],  # (1)
    FileCacheTypeVersion: NotRequired[str],
    Lifecycle: NotRequired[FileCacheLifecycleType],  # (2)
    FailureDetails: NotRequired[FileCacheFailureDetailsTypeDef],  # (3)
    StorageCapacity: NotRequired[int],
    VpcId: NotRequired[str],
    SubnetIds: NotRequired[list[str]],
    NetworkInterfaceIds: NotRequired[list[str]],
    DNSName: NotRequired[str],
    KmsKeyId: NotRequired[str],
    ResourceARN: NotRequired[str],
    Tags: NotRequired[list[TagTypeDef]],  # (4)
    CopyTagsToDataRepositoryAssociations: NotRequired[bool],
    LustreConfiguration: NotRequired[FileCacheLustreConfigurationTypeDef],  # (5)
    DataRepositoryAssociationIds: NotRequired[list[str]],
  1. See FileCacheTypeType
  2. See FileCacheLifecycleType
  3. See FileCacheFailureDetailsTypeDef
  4. See TagTypeDef
  5. See FileCacheLustreConfigurationTypeDef

FileCacheTypeDef#

# FileCacheTypeDef definition

class FileCacheTypeDef(TypedDict):
    OwnerId: NotRequired[str],
    CreationTime: NotRequired[datetime],
    FileCacheId: NotRequired[str],
    FileCacheType: NotRequired[FileCacheTypeType],  # (1)
    FileCacheTypeVersion: NotRequired[str],
    Lifecycle: NotRequired[FileCacheLifecycleType],  # (2)
    FailureDetails: NotRequired[FileCacheFailureDetailsTypeDef],  # (3)
    StorageCapacity: NotRequired[int],
    VpcId: NotRequired[str],
    SubnetIds: NotRequired[list[str]],
    NetworkInterfaceIds: NotRequired[list[str]],
    DNSName: NotRequired[str],
    KmsKeyId: NotRequired[str],
    ResourceARN: NotRequired[str],
    LustreConfiguration: NotRequired[FileCacheLustreConfigurationTypeDef],  # (4)
    DataRepositoryAssociationIds: NotRequired[list[str]],
  1. See FileCacheTypeType
  2. See FileCacheLifecycleType
  3. See FileCacheFailureDetailsTypeDef
  4. See FileCacheLustreConfigurationTypeDef

OntapFileSystemConfigurationTypeDef#

# OntapFileSystemConfigurationTypeDef definition

class OntapFileSystemConfigurationTypeDef(TypedDict):
    AutomaticBackupRetentionDays: NotRequired[int],
    DailyAutomaticBackupStartTime: NotRequired[str],
    DeploymentType: NotRequired[OntapDeploymentTypeType],  # (1)
    EndpointIpAddressRange: NotRequired[str],
    Endpoints: NotRequired[FileSystemEndpointsTypeDef],  # (2)
    DiskIopsConfiguration: NotRequired[DiskIopsConfigurationTypeDef],  # (3)
    PreferredSubnetId: NotRequired[str],
    RouteTableIds: NotRequired[list[str]],
    ThroughputCapacity: NotRequired[int],
    WeeklyMaintenanceStartTime: NotRequired[str],
    FsxAdminPassword: NotRequired[str],
    HAPairs: NotRequired[int],
    ThroughputCapacityPerHAPair: NotRequired[int],
  1. See OntapDeploymentTypeType
  2. See FileSystemEndpointsTypeDef
  3. See DiskIopsConfigurationTypeDef

CreateSnapshotResponseTypeDef#

# CreateSnapshotResponseTypeDef definition

class CreateSnapshotResponseTypeDef(TypedDict):
    Snapshot: SnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SnapshotTypeDef
  2. See ResponseMetadataTypeDef

DescribeSnapshotsResponseTypeDef#

# DescribeSnapshotsResponseTypeDef definition

class DescribeSnapshotsResponseTypeDef(TypedDict):
    Snapshots: list[SnapshotTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SnapshotTypeDef
  2. See ResponseMetadataTypeDef

UpdateSnapshotResponseTypeDef#

# UpdateSnapshotResponseTypeDef definition

class UpdateSnapshotResponseTypeDef(TypedDict):
    Snapshot: SnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SnapshotTypeDef
  2. See ResponseMetadataTypeDef

CreateFileSystemLustreConfigurationTypeDef#

# CreateFileSystemLustreConfigurationTypeDef definition

class CreateFileSystemLustreConfigurationTypeDef(TypedDict):
    WeeklyMaintenanceStartTime: NotRequired[str],
    ImportPath: NotRequired[str],
    ExportPath: NotRequired[str],
    ImportedFileChunkSize: NotRequired[int],
    DeploymentType: NotRequired[LustreDeploymentTypeType],  # (1)
    AutoImportPolicy: NotRequired[AutoImportPolicyTypeType],  # (2)
    PerUnitStorageThroughput: NotRequired[int],
    DailyAutomaticBackupStartTime: NotRequired[str],
    AutomaticBackupRetentionDays: NotRequired[int],
    CopyTagsToBackups: NotRequired[bool],
    DriveCacheType: NotRequired[DriveCacheTypeType],  # (3)
    DataCompressionType: NotRequired[DataCompressionTypeType],  # (4)
    EfaEnabled: NotRequired[bool],
    LogConfiguration: NotRequired[LustreLogCreateConfigurationTypeDef],  # (5)
    RootSquashConfiguration: NotRequired[LustreRootSquashConfigurationUnionTypeDef],  # (6)
    MetadataConfiguration: NotRequired[CreateFileSystemLustreMetadataConfigurationTypeDef],  # (7)
  1. See LustreDeploymentTypeType
  2. See AutoImportPolicyTypeType
  3. See DriveCacheTypeType
  4. See DataCompressionTypeType
  5. See LustreLogCreateConfigurationTypeDef
  6. See LustreRootSquashConfigurationTypeDef LustreRootSquashConfigurationOutputTypeDef
  7. See CreateFileSystemLustreMetadataConfigurationTypeDef

UpdateFileSystemLustreConfigurationTypeDef#

# UpdateFileSystemLustreConfigurationTypeDef definition

class UpdateFileSystemLustreConfigurationTypeDef(TypedDict):
    WeeklyMaintenanceStartTime: NotRequired[str],
    DailyAutomaticBackupStartTime: NotRequired[str],
    AutomaticBackupRetentionDays: NotRequired[int],
    AutoImportPolicy: NotRequired[AutoImportPolicyTypeType],  # (1)
    DataCompressionType: NotRequired[DataCompressionTypeType],  # (2)
    LogConfiguration: NotRequired[LustreLogCreateConfigurationTypeDef],  # (3)
    RootSquashConfiguration: NotRequired[LustreRootSquashConfigurationUnionTypeDef],  # (4)
    PerUnitStorageThroughput: NotRequired[int],
    MetadataConfiguration: NotRequired[UpdateFileSystemLustreMetadataConfigurationTypeDef],  # (5)
  1. See AutoImportPolicyTypeType
  2. See DataCompressionTypeType
  3. See LustreLogCreateConfigurationTypeDef
  4. See LustreRootSquashConfigurationTypeDef LustreRootSquashConfigurationOutputTypeDef
  5. See UpdateFileSystemLustreMetadataConfigurationTypeDef

OpenZFSVolumeConfigurationTypeDef#

# OpenZFSVolumeConfigurationTypeDef definition

class OpenZFSVolumeConfigurationTypeDef(TypedDict):
    ParentVolumeId: NotRequired[str],
    VolumePath: NotRequired[str],
    StorageCapacityReservationGiB: NotRequired[int],
    StorageCapacityQuotaGiB: NotRequired[int],
    RecordSizeKiB: NotRequired[int],
    DataCompressionType: NotRequired[OpenZFSDataCompressionTypeType],  # (1)
    CopyTagsToSnapshots: NotRequired[bool],
    OriginSnapshot: NotRequired[OpenZFSOriginSnapshotConfigurationTypeDef],  # (2)
    ReadOnly: NotRequired[bool],
    NfsExports: NotRequired[list[OpenZFSNfsExportOutputTypeDef]],  # (3)
    UserAndGroupQuotas: NotRequired[list[OpenZFSUserOrGroupQuotaTypeDef]],  # (4)
    RestoreToSnapshot: NotRequired[str],
    DeleteIntermediateSnaphots: NotRequired[bool],
    DeleteClonedVolumes: NotRequired[bool],
    DeleteIntermediateData: NotRequired[bool],
    SourceSnapshotARN: NotRequired[str],
    DestinationSnapshot: NotRequired[str],
    CopyStrategy: NotRequired[OpenZFSCopyStrategyType],  # (5)
  1. See OpenZFSDataCompressionTypeType
  2. See OpenZFSOriginSnapshotConfigurationTypeDef
  3. See OpenZFSNfsExportOutputTypeDef
  4. See OpenZFSUserOrGroupQuotaTypeDef
  5. See OpenZFSCopyStrategyType

OpenZFSNfsExportTypeDef#

# OpenZFSNfsExportTypeDef definition

class OpenZFSNfsExportTypeDef(TypedDict):
    ClientConfigurations: Sequence[OpenZFSClientConfigurationUnionTypeDef],  # (1)
  1. See OpenZFSClientConfigurationTypeDef OpenZFSClientConfigurationOutputTypeDef

CreateSnaplockConfigurationTypeDef#

# CreateSnaplockConfigurationTypeDef definition

class CreateSnaplockConfigurationTypeDef(TypedDict):
    SnaplockType: SnaplockTypeType,  # (4)
    AuditLogVolume: NotRequired[bool],
    AutocommitPeriod: NotRequired[AutocommitPeriodTypeDef],  # (1)
    PrivilegedDelete: NotRequired[PrivilegedDeleteType],  # (2)
    RetentionPeriod: NotRequired[SnaplockRetentionPeriodTypeDef],  # (3)
    VolumeAppendModeEnabled: NotRequired[bool],
  1. See AutocommitPeriodTypeDef
  2. See PrivilegedDeleteType
  3. See SnaplockRetentionPeriodTypeDef
  4. See SnaplockTypeType

SnaplockConfigurationTypeDef#

# SnaplockConfigurationTypeDef definition

class SnaplockConfigurationTypeDef(TypedDict):
    AuditLogVolume: NotRequired[bool],
    AutocommitPeriod: NotRequired[AutocommitPeriodTypeDef],  # (1)
    PrivilegedDelete: NotRequired[PrivilegedDeleteType],  # (2)
    RetentionPeriod: NotRequired[SnaplockRetentionPeriodTypeDef],  # (3)
    SnaplockType: NotRequired[SnaplockTypeType],  # (4)
    VolumeAppendModeEnabled: NotRequired[bool],
  1. See AutocommitPeriodTypeDef
  2. See PrivilegedDeleteType
  3. See SnaplockRetentionPeriodTypeDef
  4. See SnaplockTypeType

UpdateSnaplockConfigurationTypeDef#

# UpdateSnaplockConfigurationTypeDef definition

class UpdateSnaplockConfigurationTypeDef(TypedDict):
    AuditLogVolume: NotRequired[bool],
    AutocommitPeriod: NotRequired[AutocommitPeriodTypeDef],  # (1)
    PrivilegedDelete: NotRequired[PrivilegedDeleteType],  # (2)
    RetentionPeriod: NotRequired[SnaplockRetentionPeriodTypeDef],  # (3)
    VolumeAppendModeEnabled: NotRequired[bool],
  1. See AutocommitPeriodTypeDef
  2. See PrivilegedDeleteType
  3. See SnaplockRetentionPeriodTypeDef

UpdateStorageVirtualMachineRequestRequestTypeDef#

# UpdateStorageVirtualMachineRequestRequestTypeDef definition

class UpdateStorageVirtualMachineRequestRequestTypeDef(TypedDict):
    StorageVirtualMachineId: str,
    ActiveDirectoryConfiguration: NotRequired[UpdateSvmActiveDirectoryConfigurationTypeDef],  # (1)
    ClientRequestToken: NotRequired[str],
    SvmAdminPassword: NotRequired[str],
  1. See UpdateSvmActiveDirectoryConfigurationTypeDef

StorageVirtualMachineTypeDef#

# StorageVirtualMachineTypeDef definition

class StorageVirtualMachineTypeDef(TypedDict):
    ActiveDirectoryConfiguration: NotRequired[SvmActiveDirectoryConfigurationTypeDef],  # (1)
    CreationTime: NotRequired[datetime],
    Endpoints: NotRequired[SvmEndpointsTypeDef],  # (2)
    FileSystemId: NotRequired[str],
    Lifecycle: NotRequired[StorageVirtualMachineLifecycleType],  # (3)
    Name: NotRequired[str],
    ResourceARN: NotRequired[str],
    StorageVirtualMachineId: NotRequired[str],
    Subtype: NotRequired[StorageVirtualMachineSubtypeType],  # (4)
    UUID: NotRequired[str],
    Tags: NotRequired[list[TagTypeDef]],  # (5)
    LifecycleTransitionReason: NotRequired[LifecycleTransitionReasonTypeDef],  # (6)
    RootVolumeSecurityStyle: NotRequired[StorageVirtualMachineRootVolumeSecurityStyleType],  # (7)
  1. See SvmActiveDirectoryConfigurationTypeDef
  2. See SvmEndpointsTypeDef
  3. See StorageVirtualMachineLifecycleType
  4. See StorageVirtualMachineSubtypeType
  5. See TagTypeDef
  6. See LifecycleTransitionReasonTypeDef
  7. See StorageVirtualMachineRootVolumeSecurityStyleType

CreateDataRepositoryAssociationResponseTypeDef#

# CreateDataRepositoryAssociationResponseTypeDef definition

class CreateDataRepositoryAssociationResponseTypeDef(TypedDict):
    Association: DataRepositoryAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataRepositoryAssociationTypeDef
  2. See ResponseMetadataTypeDef

DescribeDataRepositoryAssociationsResponseTypeDef#

# DescribeDataRepositoryAssociationsResponseTypeDef definition

class DescribeDataRepositoryAssociationsResponseTypeDef(TypedDict):
    Associations: list[DataRepositoryAssociationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See DataRepositoryAssociationTypeDef
  2. See ResponseMetadataTypeDef

UpdateDataRepositoryAssociationResponseTypeDef#

# UpdateDataRepositoryAssociationResponseTypeDef definition

class UpdateDataRepositoryAssociationResponseTypeDef(TypedDict):
    Association: DataRepositoryAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataRepositoryAssociationTypeDef
  2. See ResponseMetadataTypeDef

CreateDataRepositoryAssociationRequestRequestTypeDef#

# CreateDataRepositoryAssociationRequestRequestTypeDef definition

class CreateDataRepositoryAssociationRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    DataRepositoryPath: str,
    FileSystemPath: NotRequired[str],
    BatchImportMetaDataOnCreate: NotRequired[bool],
    ImportedFileChunkSize: NotRequired[int],
    S3: NotRequired[S3DataRepositoryConfigurationTypeDef],  # (1)
    ClientRequestToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See S3DataRepositoryConfigurationTypeDef
  2. See TagTypeDef

UpdateDataRepositoryAssociationRequestRequestTypeDef#

# UpdateDataRepositoryAssociationRequestRequestTypeDef definition

class UpdateDataRepositoryAssociationRequestRequestTypeDef(TypedDict):
    AssociationId: str,
    ClientRequestToken: NotRequired[str],
    ImportedFileChunkSize: NotRequired[int],
    S3: NotRequired[S3DataRepositoryConfigurationTypeDef],  # (1)
  1. See S3DataRepositoryConfigurationTypeDef

CreateDataRepositoryTaskResponseTypeDef#

# CreateDataRepositoryTaskResponseTypeDef definition

class CreateDataRepositoryTaskResponseTypeDef(TypedDict):
    DataRepositoryTask: DataRepositoryTaskTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataRepositoryTaskTypeDef
  2. See ResponseMetadataTypeDef

DescribeDataRepositoryTasksResponseTypeDef#

# DescribeDataRepositoryTasksResponseTypeDef definition

class DescribeDataRepositoryTasksResponseTypeDef(TypedDict):
    DataRepositoryTasks: list[DataRepositoryTaskTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See DataRepositoryTaskTypeDef
  2. See ResponseMetadataTypeDef

CreateFileCacheResponseTypeDef#

# CreateFileCacheResponseTypeDef definition

class CreateFileCacheResponseTypeDef(TypedDict):
    FileCache: FileCacheCreatingTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileCacheCreatingTypeDef
  2. See ResponseMetadataTypeDef

DescribeFileCachesResponseTypeDef#

# DescribeFileCachesResponseTypeDef definition

class DescribeFileCachesResponseTypeDef(TypedDict):
    FileCaches: list[FileCacheTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See FileCacheTypeDef
  2. See ResponseMetadataTypeDef

UpdateFileCacheResponseTypeDef#

# UpdateFileCacheResponseTypeDef definition

class UpdateFileCacheResponseTypeDef(TypedDict):
    FileCache: FileCacheTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileCacheTypeDef
  2. See ResponseMetadataTypeDef

UpdateFileSystemRequestRequestTypeDef#

# UpdateFileSystemRequestRequestTypeDef definition

class UpdateFileSystemRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    ClientRequestToken: NotRequired[str],
    StorageCapacity: NotRequired[int],
    WindowsConfiguration: NotRequired[UpdateFileSystemWindowsConfigurationTypeDef],  # (1)
    LustreConfiguration: NotRequired[UpdateFileSystemLustreConfigurationTypeDef],  # (2)
    OntapConfiguration: NotRequired[UpdateFileSystemOntapConfigurationTypeDef],  # (3)
    OpenZFSConfiguration: NotRequired[UpdateFileSystemOpenZFSConfigurationTypeDef],  # (4)
    StorageType: NotRequired[StorageTypeType],  # (5)
  1. See UpdateFileSystemWindowsConfigurationTypeDef
  2. See UpdateFileSystemLustreConfigurationTypeDef
  3. See UpdateFileSystemOntapConfigurationTypeDef
  4. See UpdateFileSystemOpenZFSConfigurationTypeDef
  5. See StorageTypeType

CreateOntapVolumeConfigurationTypeDef#

# CreateOntapVolumeConfigurationTypeDef definition

class CreateOntapVolumeConfigurationTypeDef(TypedDict):
    StorageVirtualMachineId: str,
    JunctionPath: NotRequired[str],
    SecurityStyle: NotRequired[SecurityStyleType],  # (1)
    SizeInMegabytes: NotRequired[int],
    StorageEfficiencyEnabled: NotRequired[bool],
    TieringPolicy: NotRequired[TieringPolicyTypeDef],  # (2)
    OntapVolumeType: NotRequired[InputOntapVolumeTypeType],  # (3)
    SnapshotPolicy: NotRequired[str],
    CopyTagsToBackups: NotRequired[bool],
    SnaplockConfiguration: NotRequired[CreateSnaplockConfigurationTypeDef],  # (4)
    VolumeStyle: NotRequired[VolumeStyleType],  # (5)
    AggregateConfiguration: NotRequired[CreateAggregateConfigurationTypeDef],  # (6)
    SizeInBytes: NotRequired[int],
  1. See SecurityStyleType
  2. See TieringPolicyTypeDef
  3. See InputOntapVolumeTypeType
  4. See CreateSnaplockConfigurationTypeDef
  5. See VolumeStyleType
  6. See CreateAggregateConfigurationTypeDef

OntapVolumeConfigurationTypeDef#

# OntapVolumeConfigurationTypeDef definition

class OntapVolumeConfigurationTypeDef(TypedDict):
    FlexCacheEndpointType: NotRequired[FlexCacheEndpointTypeType],  # (1)
    JunctionPath: NotRequired[str],
    SecurityStyle: NotRequired[SecurityStyleType],  # (2)
    SizeInMegabytes: NotRequired[int],
    StorageEfficiencyEnabled: NotRequired[bool],
    StorageVirtualMachineId: NotRequired[str],
    StorageVirtualMachineRoot: NotRequired[bool],
    TieringPolicy: NotRequired[TieringPolicyTypeDef],  # (3)
    UUID: NotRequired[str],
    OntapVolumeType: NotRequired[OntapVolumeTypeType],  # (4)
    SnapshotPolicy: NotRequired[str],
    CopyTagsToBackups: NotRequired[bool],
    SnaplockConfiguration: NotRequired[SnaplockConfigurationTypeDef],  # (5)
    VolumeStyle: NotRequired[VolumeStyleType],  # (6)
    AggregateConfiguration: NotRequired[AggregateConfigurationTypeDef],  # (7)
    SizeInBytes: NotRequired[int],
  1. See FlexCacheEndpointTypeType
  2. See SecurityStyleType
  3. See TieringPolicyTypeDef
  4. See OntapVolumeTypeType
  5. See SnaplockConfigurationTypeDef
  6. See VolumeStyleType
  7. See AggregateConfigurationTypeDef

UpdateOntapVolumeConfigurationTypeDef#

# UpdateOntapVolumeConfigurationTypeDef definition

class UpdateOntapVolumeConfigurationTypeDef(TypedDict):
    JunctionPath: NotRequired[str],
    SecurityStyle: NotRequired[SecurityStyleType],  # (1)
    SizeInMegabytes: NotRequired[int],
    StorageEfficiencyEnabled: NotRequired[bool],
    TieringPolicy: NotRequired[TieringPolicyTypeDef],  # (2)
    SnapshotPolicy: NotRequired[str],
    CopyTagsToBackups: NotRequired[bool],
    SnaplockConfiguration: NotRequired[UpdateSnaplockConfigurationTypeDef],  # (3)
    SizeInBytes: NotRequired[int],
  1. See SecurityStyleType
  2. See TieringPolicyTypeDef
  3. See UpdateSnaplockConfigurationTypeDef

CreateStorageVirtualMachineResponseTypeDef#

# CreateStorageVirtualMachineResponseTypeDef definition

class CreateStorageVirtualMachineResponseTypeDef(TypedDict):
    StorageVirtualMachine: StorageVirtualMachineTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StorageVirtualMachineTypeDef
  2. See ResponseMetadataTypeDef

DescribeStorageVirtualMachinesResponseTypeDef#

# DescribeStorageVirtualMachinesResponseTypeDef definition

class DescribeStorageVirtualMachinesResponseTypeDef(TypedDict):
    StorageVirtualMachines: list[StorageVirtualMachineTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See StorageVirtualMachineTypeDef
  2. See ResponseMetadataTypeDef

UpdateStorageVirtualMachineResponseTypeDef#

# UpdateStorageVirtualMachineResponseTypeDef definition

class UpdateStorageVirtualMachineResponseTypeDef(TypedDict):
    StorageVirtualMachine: StorageVirtualMachineTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StorageVirtualMachineTypeDef
  2. See ResponseMetadataTypeDef

CreateOpenZFSVolumeConfigurationTypeDef#

# CreateOpenZFSVolumeConfigurationTypeDef definition

class CreateOpenZFSVolumeConfigurationTypeDef(TypedDict):
    ParentVolumeId: str,
    StorageCapacityReservationGiB: NotRequired[int],
    StorageCapacityQuotaGiB: NotRequired[int],
    RecordSizeKiB: NotRequired[int],
    DataCompressionType: NotRequired[OpenZFSDataCompressionTypeType],  # (1)
    CopyTagsToSnapshots: NotRequired[bool],
    OriginSnapshot: NotRequired[CreateOpenZFSOriginSnapshotConfigurationTypeDef],  # (2)
    ReadOnly: NotRequired[bool],
    NfsExports: NotRequired[Sequence[OpenZFSNfsExportUnionTypeDef]],  # (3)
    UserAndGroupQuotas: NotRequired[Sequence[OpenZFSUserOrGroupQuotaTypeDef]],  # (4)
  1. See OpenZFSDataCompressionTypeType
  2. See CreateOpenZFSOriginSnapshotConfigurationTypeDef
  3. See OpenZFSNfsExportTypeDef OpenZFSNfsExportOutputTypeDef
  4. See OpenZFSUserOrGroupQuotaTypeDef

OpenZFSCreateRootVolumeConfigurationTypeDef#

# OpenZFSCreateRootVolumeConfigurationTypeDef definition

class OpenZFSCreateRootVolumeConfigurationTypeDef(TypedDict):
    RecordSizeKiB: NotRequired[int],
    DataCompressionType: NotRequired[OpenZFSDataCompressionTypeType],  # (1)
    NfsExports: NotRequired[Sequence[OpenZFSNfsExportUnionTypeDef]],  # (2)
    UserAndGroupQuotas: NotRequired[Sequence[OpenZFSUserOrGroupQuotaTypeDef]],  # (3)
    CopyTagsToSnapshots: NotRequired[bool],
    ReadOnly: NotRequired[bool],
  1. See OpenZFSDataCompressionTypeType
  2. See OpenZFSNfsExportTypeDef OpenZFSNfsExportOutputTypeDef
  3. See OpenZFSUserOrGroupQuotaTypeDef

UpdateOpenZFSVolumeConfigurationTypeDef#

# UpdateOpenZFSVolumeConfigurationTypeDef definition

class UpdateOpenZFSVolumeConfigurationTypeDef(TypedDict):
    StorageCapacityReservationGiB: NotRequired[int],
    StorageCapacityQuotaGiB: NotRequired[int],
    RecordSizeKiB: NotRequired[int],
    DataCompressionType: NotRequired[OpenZFSDataCompressionTypeType],  # (1)
    NfsExports: NotRequired[Sequence[OpenZFSNfsExportUnionTypeDef]],  # (2)
    UserAndGroupQuotas: NotRequired[Sequence[OpenZFSUserOrGroupQuotaTypeDef]],  # (3)
    ReadOnly: NotRequired[bool],
  1. See OpenZFSDataCompressionTypeType
  2. See OpenZFSNfsExportTypeDef OpenZFSNfsExportOutputTypeDef
  3. See OpenZFSUserOrGroupQuotaTypeDef

CreateVolumeFromBackupRequestRequestTypeDef#

# CreateVolumeFromBackupRequestRequestTypeDef definition

class CreateVolumeFromBackupRequestRequestTypeDef(TypedDict):
    BackupId: str,
    Name: str,
    ClientRequestToken: NotRequired[str],
    OntapConfiguration: NotRequired[CreateOntapVolumeConfigurationTypeDef],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See CreateOntapVolumeConfigurationTypeDef
  2. See TagTypeDef

VolumePaginatorTypeDef#

# VolumePaginatorTypeDef definition

class VolumePaginatorTypeDef(TypedDict):
    CreationTime: NotRequired[datetime],
    FileSystemId: NotRequired[str],
    Lifecycle: NotRequired[VolumeLifecycleType],  # (1)
    Name: NotRequired[str],
    OntapConfiguration: NotRequired[OntapVolumeConfigurationTypeDef],  # (2)
    ResourceARN: NotRequired[str],
    Tags: NotRequired[list[TagTypeDef]],  # (3)
    VolumeId: NotRequired[str],
    VolumeType: NotRequired[VolumeTypeType],  # (4)
    LifecycleTransitionReason: NotRequired[LifecycleTransitionReasonTypeDef],  # (5)
    AdministrativeActions: NotRequired[list[dict[str, Any]]],
    OpenZFSConfiguration: NotRequired[OpenZFSVolumeConfigurationTypeDef],  # (6)
  1. See VolumeLifecycleType
  2. See OntapVolumeConfigurationTypeDef
  3. See TagTypeDef
  4. See VolumeTypeType
  5. See LifecycleTransitionReasonTypeDef
  6. See OpenZFSVolumeConfigurationTypeDef

VolumeTypeDef#

# VolumeTypeDef definition

class VolumeTypeDef(TypedDict):
    CreationTime: NotRequired[datetime],
    FileSystemId: NotRequired[str],
    Lifecycle: NotRequired[VolumeLifecycleType],  # (1)
    Name: NotRequired[str],
    OntapConfiguration: NotRequired[OntapVolumeConfigurationTypeDef],  # (2)
    ResourceARN: NotRequired[str],
    Tags: NotRequired[list[TagTypeDef]],  # (3)
    VolumeId: NotRequired[str],
    VolumeType: NotRequired[VolumeTypeType],  # (4)
    LifecycleTransitionReason: NotRequired[LifecycleTransitionReasonTypeDef],  # (5)
    AdministrativeActions: NotRequired[list[dict[str, Any]]],
    OpenZFSConfiguration: NotRequired[OpenZFSVolumeConfigurationTypeDef],  # (6)
  1. See VolumeLifecycleType
  2. See OntapVolumeConfigurationTypeDef
  3. See TagTypeDef
  4. See VolumeTypeType
  5. See LifecycleTransitionReasonTypeDef
  6. See OpenZFSVolumeConfigurationTypeDef

CreateVolumeRequestRequestTypeDef#

# CreateVolumeRequestRequestTypeDef definition

class CreateVolumeRequestRequestTypeDef(TypedDict):
    VolumeType: VolumeTypeType,  # (1)
    Name: str,
    ClientRequestToken: NotRequired[str],
    OntapConfiguration: NotRequired[CreateOntapVolumeConfigurationTypeDef],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    OpenZFSConfiguration: NotRequired[CreateOpenZFSVolumeConfigurationTypeDef],  # (4)
  1. See VolumeTypeType
  2. See CreateOntapVolumeConfigurationTypeDef
  3. See TagTypeDef
  4. See CreateOpenZFSVolumeConfigurationTypeDef

CreateFileSystemOpenZFSConfigurationTypeDef#

# CreateFileSystemOpenZFSConfigurationTypeDef definition

class CreateFileSystemOpenZFSConfigurationTypeDef(TypedDict):
    DeploymentType: OpenZFSDeploymentTypeType,  # (1)
    ThroughputCapacity: int,
    AutomaticBackupRetentionDays: NotRequired[int],
    CopyTagsToBackups: NotRequired[bool],
    CopyTagsToVolumes: NotRequired[bool],
    DailyAutomaticBackupStartTime: NotRequired[str],
    WeeklyMaintenanceStartTime: NotRequired[str],
    DiskIopsConfiguration: NotRequired[DiskIopsConfigurationTypeDef],  # (2)
    RootVolumeConfiguration: NotRequired[OpenZFSCreateRootVolumeConfigurationTypeDef],  # (3)
    PreferredSubnetId: NotRequired[str],
    EndpointIpAddressRange: NotRequired[str],
    RouteTableIds: NotRequired[Sequence[str]],
    ReadCacheConfiguration: NotRequired[OpenZFSReadCacheConfigurationTypeDef],  # (4)
  1. See OpenZFSDeploymentTypeType
  2. See DiskIopsConfigurationTypeDef
  3. See OpenZFSCreateRootVolumeConfigurationTypeDef
  4. See OpenZFSReadCacheConfigurationTypeDef

UpdateVolumeRequestRequestTypeDef#

# UpdateVolumeRequestRequestTypeDef definition

class UpdateVolumeRequestRequestTypeDef(TypedDict):
    VolumeId: str,
    ClientRequestToken: NotRequired[str],
    OntapConfiguration: NotRequired[UpdateOntapVolumeConfigurationTypeDef],  # (1)
    Name: NotRequired[str],
    OpenZFSConfiguration: NotRequired[UpdateOpenZFSVolumeConfigurationTypeDef],  # (2)
  1. See UpdateOntapVolumeConfigurationTypeDef
  2. See UpdateOpenZFSVolumeConfigurationTypeDef

AdministrativeActionPaginatorTypeDef#

# AdministrativeActionPaginatorTypeDef definition

class AdministrativeActionPaginatorTypeDef(TypedDict):
    AdministrativeActionType: NotRequired[AdministrativeActionTypeType],  # (1)
    ProgressPercent: NotRequired[int],
    RequestTime: NotRequired[datetime],
    Status: NotRequired[StatusType],  # (2)
    TargetFileSystemValues: NotRequired[dict[str, Any]],
    FailureDetails: NotRequired[AdministrativeActionFailureDetailsTypeDef],  # (3)
    TargetVolumeValues: NotRequired[VolumePaginatorTypeDef],  # (4)
    TargetSnapshotValues: NotRequired[SnapshotPaginatorTypeDef],  # (5)
    TotalTransferBytes: NotRequired[int],
    RemainingTransferBytes: NotRequired[int],
  1. See AdministrativeActionTypeType
  2. See StatusType
  3. See AdministrativeActionFailureDetailsTypeDef
  4. See VolumePaginatorTypeDef
  5. See SnapshotPaginatorTypeDef

DescribeVolumesResponsePaginatorTypeDef#

# DescribeVolumesResponsePaginatorTypeDef definition

class DescribeVolumesResponsePaginatorTypeDef(TypedDict):
    Volumes: list[VolumePaginatorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See VolumePaginatorTypeDef
  2. See ResponseMetadataTypeDef

AdministrativeActionTypeDef#

# AdministrativeActionTypeDef definition

class AdministrativeActionTypeDef(TypedDict):
    AdministrativeActionType: NotRequired[AdministrativeActionTypeType],  # (1)
    ProgressPercent: NotRequired[int],
    RequestTime: NotRequired[datetime],
    Status: NotRequired[StatusType],  # (2)
    TargetFileSystemValues: NotRequired[dict[str, Any]],
    FailureDetails: NotRequired[AdministrativeActionFailureDetailsTypeDef],  # (3)
    TargetVolumeValues: NotRequired[VolumeTypeDef],  # (4)
    TargetSnapshotValues: NotRequired[SnapshotTypeDef],  # (5)
    TotalTransferBytes: NotRequired[int],
    RemainingTransferBytes: NotRequired[int],
  1. See AdministrativeActionTypeType
  2. See StatusType
  3. See AdministrativeActionFailureDetailsTypeDef
  4. See VolumeTypeDef
  5. See SnapshotTypeDef

CreateVolumeFromBackupResponseTypeDef#

# CreateVolumeFromBackupResponseTypeDef definition

class CreateVolumeFromBackupResponseTypeDef(TypedDict):
    Volume: VolumeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VolumeTypeDef
  2. See ResponseMetadataTypeDef

CreateVolumeResponseTypeDef#

# CreateVolumeResponseTypeDef definition

class CreateVolumeResponseTypeDef(TypedDict):
    Volume: VolumeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VolumeTypeDef
  2. See ResponseMetadataTypeDef

DescribeVolumesResponseTypeDef#

# DescribeVolumesResponseTypeDef definition

class DescribeVolumesResponseTypeDef(TypedDict):
    Volumes: list[VolumeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See VolumeTypeDef
  2. See ResponseMetadataTypeDef

UpdateVolumeResponseTypeDef#

# UpdateVolumeResponseTypeDef definition

class UpdateVolumeResponseTypeDef(TypedDict):
    Volume: VolumeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VolumeTypeDef
  2. See ResponseMetadataTypeDef

CreateFileSystemFromBackupRequestRequestTypeDef#

# CreateFileSystemFromBackupRequestRequestTypeDef definition

class CreateFileSystemFromBackupRequestRequestTypeDef(TypedDict):
    BackupId: str,
    SubnetIds: Sequence[str],
    ClientRequestToken: NotRequired[str],
    SecurityGroupIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    WindowsConfiguration: NotRequired[CreateFileSystemWindowsConfigurationTypeDef],  # (2)
    LustreConfiguration: NotRequired[CreateFileSystemLustreConfigurationTypeDef],  # (3)
    StorageType: NotRequired[StorageTypeType],  # (4)
    KmsKeyId: NotRequired[str],
    FileSystemTypeVersion: NotRequired[str],
    OpenZFSConfiguration: NotRequired[CreateFileSystemOpenZFSConfigurationTypeDef],  # (5)
    StorageCapacity: NotRequired[int],
  1. See TagTypeDef
  2. See CreateFileSystemWindowsConfigurationTypeDef
  3. See CreateFileSystemLustreConfigurationTypeDef
  4. See StorageTypeType
  5. See CreateFileSystemOpenZFSConfigurationTypeDef

CreateFileSystemRequestRequestTypeDef#

# CreateFileSystemRequestRequestTypeDef definition

class CreateFileSystemRequestRequestTypeDef(TypedDict):
    FileSystemType: FileSystemTypeType,  # (1)
    SubnetIds: Sequence[str],
    ClientRequestToken: NotRequired[str],
    StorageCapacity: NotRequired[int],
    StorageType: NotRequired[StorageTypeType],  # (2)
    SecurityGroupIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    KmsKeyId: NotRequired[str],
    WindowsConfiguration: NotRequired[CreateFileSystemWindowsConfigurationTypeDef],  # (4)
    LustreConfiguration: NotRequired[CreateFileSystemLustreConfigurationTypeDef],  # (5)
    OntapConfiguration: NotRequired[CreateFileSystemOntapConfigurationTypeDef],  # (6)
    FileSystemTypeVersion: NotRequired[str],
    OpenZFSConfiguration: NotRequired[CreateFileSystemOpenZFSConfigurationTypeDef],  # (7)
  1. See FileSystemTypeType
  2. See StorageTypeType
  3. See TagTypeDef
  4. See CreateFileSystemWindowsConfigurationTypeDef
  5. See CreateFileSystemLustreConfigurationTypeDef
  6. See CreateFileSystemOntapConfigurationTypeDef
  7. See CreateFileSystemOpenZFSConfigurationTypeDef

FileSystemPaginatorTypeDef#

# FileSystemPaginatorTypeDef definition

class FileSystemPaginatorTypeDef(TypedDict):
    OwnerId: NotRequired[str],
    CreationTime: NotRequired[datetime],
    FileSystemId: NotRequired[str],
    FileSystemType: NotRequired[FileSystemTypeType],  # (1)
    Lifecycle: NotRequired[FileSystemLifecycleType],  # (2)
    FailureDetails: NotRequired[FileSystemFailureDetailsTypeDef],  # (3)
    StorageCapacity: NotRequired[int],
    StorageType: NotRequired[StorageTypeType],  # (4)
    VpcId: NotRequired[str],
    SubnetIds: NotRequired[list[str]],
    NetworkInterfaceIds: NotRequired[list[str]],
    DNSName: NotRequired[str],
    KmsKeyId: NotRequired[str],
    ResourceARN: NotRequired[str],
    Tags: NotRequired[list[TagTypeDef]],  # (5)
    WindowsConfiguration: NotRequired[WindowsFileSystemConfigurationTypeDef],  # (6)
    LustreConfiguration: NotRequired[LustreFileSystemConfigurationTypeDef],  # (7)
    AdministrativeActions: NotRequired[list[AdministrativeActionPaginatorTypeDef]],  # (8)
    OntapConfiguration: NotRequired[OntapFileSystemConfigurationTypeDef],  # (9)
    FileSystemTypeVersion: NotRequired[str],
    OpenZFSConfiguration: NotRequired[OpenZFSFileSystemConfigurationTypeDef],  # (10)
  1. See FileSystemTypeType
  2. See FileSystemLifecycleType
  3. See FileSystemFailureDetailsTypeDef
  4. See StorageTypeType
  5. See TagTypeDef
  6. See WindowsFileSystemConfigurationTypeDef
  7. See LustreFileSystemConfigurationTypeDef
  8. See AdministrativeActionPaginatorTypeDef
  9. See OntapFileSystemConfigurationTypeDef
  10. See OpenZFSFileSystemConfigurationTypeDef

CopySnapshotAndUpdateVolumeResponseTypeDef#

# CopySnapshotAndUpdateVolumeResponseTypeDef definition

class CopySnapshotAndUpdateVolumeResponseTypeDef(TypedDict):
    VolumeId: str,
    Lifecycle: VolumeLifecycleType,  # (1)
    AdministrativeActions: list[AdministrativeActionTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See VolumeLifecycleType
  2. See AdministrativeActionTypeDef
  3. See ResponseMetadataTypeDef

FileSystemTypeDef#

# FileSystemTypeDef definition

class FileSystemTypeDef(TypedDict):
    OwnerId: NotRequired[str],
    CreationTime: NotRequired[datetime],
    FileSystemId: NotRequired[str],
    FileSystemType: NotRequired[FileSystemTypeType],  # (1)
    Lifecycle: NotRequired[FileSystemLifecycleType],  # (2)
    FailureDetails: NotRequired[FileSystemFailureDetailsTypeDef],  # (3)
    StorageCapacity: NotRequired[int],
    StorageType: NotRequired[StorageTypeType],  # (4)
    VpcId: NotRequired[str],
    SubnetIds: NotRequired[list[str]],
    NetworkInterfaceIds: NotRequired[list[str]],
    DNSName: NotRequired[str],
    KmsKeyId: NotRequired[str],
    ResourceARN: NotRequired[str],
    Tags: NotRequired[list[TagTypeDef]],  # (5)
    WindowsConfiguration: NotRequired[WindowsFileSystemConfigurationTypeDef],  # (6)
    LustreConfiguration: NotRequired[LustreFileSystemConfigurationTypeDef],  # (7)
    AdministrativeActions: NotRequired[list[AdministrativeActionTypeDef]],  # (8)
    OntapConfiguration: NotRequired[OntapFileSystemConfigurationTypeDef],  # (9)
    FileSystemTypeVersion: NotRequired[str],
    OpenZFSConfiguration: NotRequired[OpenZFSFileSystemConfigurationTypeDef],  # (10)
  1. See FileSystemTypeType
  2. See FileSystemLifecycleType
  3. See FileSystemFailureDetailsTypeDef
  4. See StorageTypeType
  5. See TagTypeDef
  6. See WindowsFileSystemConfigurationTypeDef
  7. See LustreFileSystemConfigurationTypeDef
  8. See AdministrativeActionTypeDef
  9. See OntapFileSystemConfigurationTypeDef
  10. See OpenZFSFileSystemConfigurationTypeDef

RestoreVolumeFromSnapshotResponseTypeDef#

# RestoreVolumeFromSnapshotResponseTypeDef definition

class RestoreVolumeFromSnapshotResponseTypeDef(TypedDict):
    VolumeId: str,
    Lifecycle: VolumeLifecycleType,  # (1)
    AdministrativeActions: list[AdministrativeActionTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See VolumeLifecycleType
  2. See AdministrativeActionTypeDef
  3. See ResponseMetadataTypeDef

BackupPaginatorTypeDef#

# BackupPaginatorTypeDef definition

class BackupPaginatorTypeDef(TypedDict):
    BackupId: str,
    Lifecycle: BackupLifecycleType,  # (1)
    Type: BackupTypeType,  # (3)
    CreationTime: datetime,
    FileSystem: FileSystemPaginatorTypeDef,  # (5)
    FailureDetails: NotRequired[BackupFailureDetailsTypeDef],  # (2)
    ProgressPercent: NotRequired[int],
    KmsKeyId: NotRequired[str],
    ResourceARN: NotRequired[str],
    Tags: NotRequired[list[TagTypeDef]],  # (4)
    DirectoryInformation: NotRequired[ActiveDirectoryBackupAttributesTypeDef],  # (6)
    OwnerId: NotRequired[str],
    SourceBackupId: NotRequired[str],
    SourceBackupRegion: NotRequired[str],
    ResourceType: NotRequired[ResourceTypeType],  # (7)
    Volume: NotRequired[VolumePaginatorTypeDef],  # (8)
    SizeInBytes: NotRequired[int],
  1. See BackupLifecycleType
  2. See BackupFailureDetailsTypeDef
  3. See BackupTypeType
  4. See TagTypeDef
  5. See FileSystemPaginatorTypeDef
  6. See ActiveDirectoryBackupAttributesTypeDef
  7. See ResourceTypeType
  8. See VolumePaginatorTypeDef

DescribeFileSystemsResponsePaginatorTypeDef#

# DescribeFileSystemsResponsePaginatorTypeDef definition

class DescribeFileSystemsResponsePaginatorTypeDef(TypedDict):
    FileSystems: list[FileSystemPaginatorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See FileSystemPaginatorTypeDef
  2. See ResponseMetadataTypeDef

BackupTypeDef#

# BackupTypeDef definition

class BackupTypeDef(TypedDict):
    BackupId: str,
    Lifecycle: BackupLifecycleType,  # (1)
    Type: BackupTypeType,  # (3)
    CreationTime: datetime,
    FileSystem: FileSystemTypeDef,  # (5)
    FailureDetails: NotRequired[BackupFailureDetailsTypeDef],  # (2)
    ProgressPercent: NotRequired[int],
    KmsKeyId: NotRequired[str],
    ResourceARN: NotRequired[str],
    Tags: NotRequired[list[TagTypeDef]],  # (4)
    DirectoryInformation: NotRequired[ActiveDirectoryBackupAttributesTypeDef],  # (6)
    OwnerId: NotRequired[str],
    SourceBackupId: NotRequired[str],
    SourceBackupRegion: NotRequired[str],
    ResourceType: NotRequired[ResourceTypeType],  # (7)
    Volume: NotRequired[VolumeTypeDef],  # (8)
    SizeInBytes: NotRequired[int],
  1. See BackupLifecycleType
  2. See BackupFailureDetailsTypeDef
  3. See BackupTypeType
  4. See TagTypeDef
  5. See FileSystemTypeDef
  6. See ActiveDirectoryBackupAttributesTypeDef
  7. See ResourceTypeType
  8. See VolumeTypeDef

CreateFileSystemFromBackupResponseTypeDef#

# CreateFileSystemFromBackupResponseTypeDef definition

class CreateFileSystemFromBackupResponseTypeDef(TypedDict):
    FileSystem: FileSystemTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileSystemTypeDef
  2. See ResponseMetadataTypeDef

CreateFileSystemResponseTypeDef#

# CreateFileSystemResponseTypeDef definition

class CreateFileSystemResponseTypeDef(TypedDict):
    FileSystem: FileSystemTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileSystemTypeDef
  2. See ResponseMetadataTypeDef

DescribeFileSystemsResponseTypeDef#

# DescribeFileSystemsResponseTypeDef definition

class DescribeFileSystemsResponseTypeDef(TypedDict):
    FileSystems: list[FileSystemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See FileSystemTypeDef
  2. See ResponseMetadataTypeDef

ReleaseFileSystemNfsV3LocksResponseTypeDef#

# ReleaseFileSystemNfsV3LocksResponseTypeDef definition

class ReleaseFileSystemNfsV3LocksResponseTypeDef(TypedDict):
    FileSystem: FileSystemTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileSystemTypeDef
  2. See ResponseMetadataTypeDef

StartMisconfiguredStateRecoveryResponseTypeDef#

# StartMisconfiguredStateRecoveryResponseTypeDef definition

class StartMisconfiguredStateRecoveryResponseTypeDef(TypedDict):
    FileSystem: FileSystemTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileSystemTypeDef
  2. See ResponseMetadataTypeDef

UpdateFileSystemResponseTypeDef#

# UpdateFileSystemResponseTypeDef definition

class UpdateFileSystemResponseTypeDef(TypedDict):
    FileSystem: FileSystemTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileSystemTypeDef
  2. See ResponseMetadataTypeDef

DescribeBackupsResponsePaginatorTypeDef#

# DescribeBackupsResponsePaginatorTypeDef definition

class DescribeBackupsResponsePaginatorTypeDef(TypedDict):
    Backups: list[BackupPaginatorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See BackupPaginatorTypeDef
  2. See ResponseMetadataTypeDef

CopyBackupResponseTypeDef#

# CopyBackupResponseTypeDef definition

class CopyBackupResponseTypeDef(TypedDict):
    Backup: BackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackupTypeDef
  2. See ResponseMetadataTypeDef

CreateBackupResponseTypeDef#

# CreateBackupResponseTypeDef definition

class CreateBackupResponseTypeDef(TypedDict):
    Backup: BackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackupTypeDef
  2. See ResponseMetadataTypeDef

DescribeBackupsResponseTypeDef#

# DescribeBackupsResponseTypeDef definition

class DescribeBackupsResponseTypeDef(TypedDict):
    Backups: list[BackupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See BackupTypeDef
  2. See ResponseMetadataTypeDef