Skip to content

Type definitions#

Index > EFS > Type definitions

Auto-generated documentation for EFS type annotations stubs module mypy-boto3-efs.

PosixUserUnionTypeDef#

# PosixUserUnionTypeDef definition

PosixUserUnionTypeDef = Union[
    PosixUserTypeDef,  # (1)
    PosixUserExtraOutputTypeDef,  # (2)
]
  1. See PosixUserTypeDef
  2. See PosixUserExtraOutputTypeDef

PosixUserOutputTypeDef#

# PosixUserOutputTypeDef definition

class PosixUserOutputTypeDef(TypedDict):
    Uid: int,
    Gid: int,
    SecondaryGids: NotRequired[List[int]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

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

BackupPolicyTypeDef#

# BackupPolicyTypeDef definition

class BackupPolicyTypeDef(TypedDict):
    Status: StatusType,  # (1)
  1. See StatusType

PosixUserTypeDef#

# PosixUserTypeDef definition

class PosixUserTypeDef(TypedDict):
    Uid: int,
    Gid: int,
    SecondaryGids: NotRequired[Sequence[int]],

CreateMountTargetRequestRequestTypeDef#

# CreateMountTargetRequestRequestTypeDef definition

class CreateMountTargetRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    SubnetId: str,
    IpAddress: NotRequired[str],
    SecurityGroups: NotRequired[Sequence[str]],

DestinationToCreateTypeDef#

# DestinationToCreateTypeDef definition

class DestinationToCreateTypeDef(TypedDict):
    Region: NotRequired[str],
    AvailabilityZoneName: NotRequired[str],
    KmsKeyId: NotRequired[str],
    FileSystemId: NotRequired[str],

CreationInfoTypeDef#

# CreationInfoTypeDef definition

class CreationInfoTypeDef(TypedDict):
    OwnerUid: int,
    OwnerGid: int,
    Permissions: str,

DeleteAccessPointRequestRequestTypeDef#

# DeleteAccessPointRequestRequestTypeDef definition

class DeleteAccessPointRequestRequestTypeDef(TypedDict):
    AccessPointId: str,

DeleteFileSystemPolicyRequestRequestTypeDef#

# DeleteFileSystemPolicyRequestRequestTypeDef definition

class DeleteFileSystemPolicyRequestRequestTypeDef(TypedDict):
    FileSystemId: str,

DeleteFileSystemRequestRequestTypeDef#

# DeleteFileSystemRequestRequestTypeDef definition

class DeleteFileSystemRequestRequestTypeDef(TypedDict):
    FileSystemId: str,

DeleteMountTargetRequestRequestTypeDef#

# DeleteMountTargetRequestRequestTypeDef definition

class DeleteMountTargetRequestRequestTypeDef(TypedDict):
    MountTargetId: str,

DeleteReplicationConfigurationRequestRequestTypeDef#

# DeleteReplicationConfigurationRequestRequestTypeDef definition

class DeleteReplicationConfigurationRequestRequestTypeDef(TypedDict):
    SourceFileSystemId: str,

DeleteTagsRequestRequestTypeDef#

# DeleteTagsRequestRequestTypeDef definition

class DeleteTagsRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    TagKeys: Sequence[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeAccessPointsRequestRequestTypeDef#

# DescribeAccessPointsRequestRequestTypeDef definition

class DescribeAccessPointsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    AccessPointId: NotRequired[str],
    FileSystemId: NotRequired[str],

DescribeAccountPreferencesRequestRequestTypeDef#

# DescribeAccountPreferencesRequestRequestTypeDef definition

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

ResourceIdPreferenceTypeDef#

# ResourceIdPreferenceTypeDef definition

class ResourceIdPreferenceTypeDef(TypedDict):
    ResourceIdType: NotRequired[ResourceIdTypeType],  # (1)
    Resources: NotRequired[List[ResourceType]],  # (2)
  1. See ResourceIdTypeType
  2. See ResourceType

DescribeBackupPolicyRequestRequestTypeDef#

# DescribeBackupPolicyRequestRequestTypeDef definition

class DescribeBackupPolicyRequestRequestTypeDef(TypedDict):
    FileSystemId: str,

DescribeFileSystemPolicyRequestRequestTypeDef#

# DescribeFileSystemPolicyRequestRequestTypeDef definition

class DescribeFileSystemPolicyRequestRequestTypeDef(TypedDict):
    FileSystemId: str,

DescribeFileSystemsRequestRequestTypeDef#

# DescribeFileSystemsRequestRequestTypeDef definition

class DescribeFileSystemsRequestRequestTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    Marker: NotRequired[str],
    CreationToken: NotRequired[str],
    FileSystemId: NotRequired[str],

DescribeLifecycleConfigurationRequestRequestTypeDef#

# DescribeLifecycleConfigurationRequestRequestTypeDef definition

class DescribeLifecycleConfigurationRequestRequestTypeDef(TypedDict):
    FileSystemId: str,

DescribeMountTargetSecurityGroupsRequestRequestTypeDef#

# DescribeMountTargetSecurityGroupsRequestRequestTypeDef definition

class DescribeMountTargetSecurityGroupsRequestRequestTypeDef(TypedDict):
    MountTargetId: str,

DescribeMountTargetsRequestRequestTypeDef#

# DescribeMountTargetsRequestRequestTypeDef definition

class DescribeMountTargetsRequestRequestTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    Marker: NotRequired[str],
    FileSystemId: NotRequired[str],
    MountTargetId: NotRequired[str],
    AccessPointId: NotRequired[str],

MountTargetDescriptionTypeDef#

# MountTargetDescriptionTypeDef definition

class MountTargetDescriptionTypeDef(TypedDict):
    MountTargetId: str,
    FileSystemId: str,
    SubnetId: str,
    LifeCycleState: LifeCycleStateType,  # (1)
    OwnerId: NotRequired[str],
    IpAddress: NotRequired[str],
    NetworkInterfaceId: NotRequired[str],
    AvailabilityZoneId: NotRequired[str],
    AvailabilityZoneName: NotRequired[str],
    VpcId: NotRequired[str],
  1. See LifeCycleStateType

DescribeReplicationConfigurationsRequestRequestTypeDef#

# DescribeReplicationConfigurationsRequestRequestTypeDef definition

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

DescribeTagsRequestRequestTypeDef#

# DescribeTagsRequestRequestTypeDef definition

class DescribeTagsRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    MaxItems: NotRequired[int],
    Marker: NotRequired[str],

DestinationTypeDef#

# DestinationTypeDef definition

class DestinationTypeDef(TypedDict):
    Status: ReplicationStatusType,  # (1)
    FileSystemId: str,
    Region: str,
    LastReplicatedTimestamp: NotRequired[datetime],
  1. See ReplicationStatusType

FileSystemProtectionDescriptionTypeDef#

# FileSystemProtectionDescriptionTypeDef definition

class FileSystemProtectionDescriptionTypeDef(TypedDict):
    ReplicationOverwriteProtection: NotRequired[ReplicationOverwriteProtectionType],  # (1)
  1. See ReplicationOverwriteProtectionType

FileSystemSizeTypeDef#

# FileSystemSizeTypeDef definition

class FileSystemSizeTypeDef(TypedDict):
    Value: int,
    Timestamp: NotRequired[datetime],
    ValueInIA: NotRequired[int],
    ValueInStandard: NotRequired[int],
    ValueInArchive: NotRequired[int],

LifecyclePolicyTypeDef#

# LifecyclePolicyTypeDef definition

class LifecyclePolicyTypeDef(TypedDict):
    TransitionToIA: NotRequired[TransitionToIARulesType],  # (1)
    TransitionToPrimaryStorageClass: NotRequired[TransitionToPrimaryStorageClassRulesType],  # (2)
    TransitionToArchive: NotRequired[TransitionToArchiveRulesType],  # (3)
  1. See TransitionToIARulesType
  2. See TransitionToPrimaryStorageClassRulesType
  3. See TransitionToArchiveRulesType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

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

ModifyMountTargetSecurityGroupsRequestRequestTypeDef#

# ModifyMountTargetSecurityGroupsRequestRequestTypeDef definition

class ModifyMountTargetSecurityGroupsRequestRequestTypeDef(TypedDict):
    MountTargetId: str,
    SecurityGroups: NotRequired[Sequence[str]],

PosixUserExtraOutputTypeDef#

# PosixUserExtraOutputTypeDef definition

class PosixUserExtraOutputTypeDef(TypedDict):
    Uid: int,
    Gid: int,
    SecondaryGids: NotRequired[List[int]],

PutAccountPreferencesRequestRequestTypeDef#

# PutAccountPreferencesRequestRequestTypeDef definition

class PutAccountPreferencesRequestRequestTypeDef(TypedDict):
    ResourceIdType: ResourceIdTypeType,  # (1)
  1. See ResourceIdTypeType

PutFileSystemPolicyRequestRequestTypeDef#

# PutFileSystemPolicyRequestRequestTypeDef definition

class PutFileSystemPolicyRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    Policy: str,
    BypassPolicyLockoutSafetyCheck: NotRequired[bool],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateFileSystemProtectionRequestRequestTypeDef#

# UpdateFileSystemProtectionRequestRequestTypeDef definition

class UpdateFileSystemProtectionRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    ReplicationOverwriteProtection: NotRequired[ReplicationOverwriteProtectionType],  # (1)
  1. See ReplicationOverwriteProtectionType

UpdateFileSystemRequestRequestTypeDef#

# UpdateFileSystemRequestRequestTypeDef definition

class UpdateFileSystemRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    ThroughputMode: NotRequired[ThroughputModeType],  # (1)
    ProvisionedThroughputInMibps: NotRequired[float],
  1. See ThroughputModeType

DescribeMountTargetSecurityGroupsResponseTypeDef#

# DescribeMountTargetSecurityGroupsResponseTypeDef definition

class DescribeMountTargetSecurityGroupsResponseTypeDef(TypedDict):
    SecurityGroups: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

FileSystemPolicyDescriptionTypeDef#

# FileSystemPolicyDescriptionTypeDef definition

class FileSystemPolicyDescriptionTypeDef(TypedDict):
    FileSystemId: str,
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

FileSystemProtectionDescriptionResponseTypeDef#

# FileSystemProtectionDescriptionResponseTypeDef definition

class FileSystemProtectionDescriptionResponseTypeDef(TypedDict):
    ReplicationOverwriteProtection: ReplicationOverwriteProtectionType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationOverwriteProtectionType
  2. See ResponseMetadataTypeDef

MountTargetDescriptionResponseTypeDef#

# MountTargetDescriptionResponseTypeDef definition

class MountTargetDescriptionResponseTypeDef(TypedDict):
    OwnerId: str,
    MountTargetId: str,
    FileSystemId: str,
    SubnetId: str,
    LifeCycleState: LifeCycleStateType,  # (1)
    IpAddress: str,
    NetworkInterfaceId: str,
    AvailabilityZoneId: str,
    AvailabilityZoneName: str,
    VpcId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LifeCycleStateType
  2. See ResponseMetadataTypeDef

CreateFileSystemRequestRequestTypeDef#

# CreateFileSystemRequestRequestTypeDef definition

class CreateFileSystemRequestRequestTypeDef(TypedDict):
    CreationToken: str,
    PerformanceMode: NotRequired[PerformanceModeType],  # (1)
    Encrypted: NotRequired[bool],
    KmsKeyId: NotRequired[str],
    ThroughputMode: NotRequired[ThroughputModeType],  # (2)
    ProvisionedThroughputInMibps: NotRequired[float],
    AvailabilityZoneName: NotRequired[str],
    Backup: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See PerformanceModeType
  2. See ThroughputModeType
  3. See TagTypeDef

CreateTagsRequestRequestTypeDef#

# CreateTagsRequestRequestTypeDef definition

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

DescribeTagsResponseTypeDef#

# DescribeTagsResponseTypeDef definition

class DescribeTagsResponseTypeDef(TypedDict):
    Marker: str,
    Tags: List[TagTypeDef],  # (1)
    NextMarker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

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):
    ResourceId: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

BackupPolicyDescriptionTypeDef#

# BackupPolicyDescriptionTypeDef definition

class BackupPolicyDescriptionTypeDef(TypedDict):
    BackupPolicy: BackupPolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackupPolicyTypeDef
  2. See ResponseMetadataTypeDef

PutBackupPolicyRequestRequestTypeDef#

# PutBackupPolicyRequestRequestTypeDef definition

class PutBackupPolicyRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    BackupPolicy: BackupPolicyTypeDef,  # (1)
  1. See BackupPolicyTypeDef

CreateReplicationConfigurationRequestRequestTypeDef#

# CreateReplicationConfigurationRequestRequestTypeDef definition

class CreateReplicationConfigurationRequestRequestTypeDef(TypedDict):
    SourceFileSystemId: str,
    Destinations: Sequence[DestinationToCreateTypeDef],  # (1)
  1. See DestinationToCreateTypeDef

RootDirectoryTypeDef#

# RootDirectoryTypeDef definition

class RootDirectoryTypeDef(TypedDict):
    Path: NotRequired[str],
    CreationInfo: NotRequired[CreationInfoTypeDef],  # (1)
  1. See CreationInfoTypeDef

DescribeAccessPointsRequestDescribeAccessPointsPaginateTypeDef#

# DescribeAccessPointsRequestDescribeAccessPointsPaginateTypeDef definition

class DescribeAccessPointsRequestDescribeAccessPointsPaginateTypeDef(TypedDict):
    AccessPointId: NotRequired[str],
    FileSystemId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef#

# DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef definition

class DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef(TypedDict):
    CreationToken: NotRequired[str],
    FileSystemId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeMountTargetsRequestDescribeMountTargetsPaginateTypeDef#

# DescribeMountTargetsRequestDescribeMountTargetsPaginateTypeDef definition

class DescribeMountTargetsRequestDescribeMountTargetsPaginateTypeDef(TypedDict):
    FileSystemId: NotRequired[str],
    MountTargetId: NotRequired[str],
    AccessPointId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeReplicationConfigurationsRequestDescribeReplicationConfigurationsPaginateTypeDef#

# DescribeReplicationConfigurationsRequestDescribeReplicationConfigurationsPaginateTypeDef definition

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