Skip to content

Typed dictionaries#

Index > EFS > Typed dictionaries

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

PosixUserTypeDef#

# PosixUserTypeDef usage example

from mypy_boto3_efs.type_defs import PosixUserTypeDef

def get_value() -> PosixUserTypeDef:
    return {
        "Uid": ...,
        "Gid": ...,
    }
# PosixUserTypeDef definition

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

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_efs.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
# TagTypeDef definition

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

BackupPolicyTypeDef#

# BackupPolicyTypeDef usage example

from mypy_boto3_efs.type_defs import BackupPolicyTypeDef

def get_value() -> BackupPolicyTypeDef:
    return {
        "Status": ...,
    }
# BackupPolicyTypeDef definition

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

CreateMountTargetRequestRequestTypeDef#

# CreateMountTargetRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import CreateMountTargetRequestRequestTypeDef

def get_value() -> CreateMountTargetRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
        "SubnetId": ...,
    }
# CreateMountTargetRequestRequestTypeDef definition

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

DestinationToCreateTypeDef#

# DestinationToCreateTypeDef usage example

from mypy_boto3_efs.type_defs import DestinationToCreateTypeDef

def get_value() -> DestinationToCreateTypeDef:
    return {
        "Region": ...,
    }
# DestinationToCreateTypeDef definition

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

CreationInfoTypeDef#

# CreationInfoTypeDef usage example

from mypy_boto3_efs.type_defs import CreationInfoTypeDef

def get_value() -> CreationInfoTypeDef:
    return {
        "OwnerUid": ...,
        "OwnerGid": ...,
        "Permissions": ...,
    }
# CreationInfoTypeDef definition

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

DeleteAccessPointRequestRequestTypeDef#

# DeleteAccessPointRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DeleteAccessPointRequestRequestTypeDef

def get_value() -> DeleteAccessPointRequestRequestTypeDef:
    return {
        "AccessPointId": ...,
    }
# DeleteAccessPointRequestRequestTypeDef definition

class DeleteAccessPointRequestRequestTypeDef(TypedDict):
    AccessPointId: str,

DeleteFileSystemPolicyRequestRequestTypeDef#

# DeleteFileSystemPolicyRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DeleteFileSystemPolicyRequestRequestTypeDef

def get_value() -> DeleteFileSystemPolicyRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
    }
# DeleteFileSystemPolicyRequestRequestTypeDef definition

class DeleteFileSystemPolicyRequestRequestTypeDef(TypedDict):
    FileSystemId: str,

DeleteFileSystemRequestRequestTypeDef#

# DeleteFileSystemRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DeleteFileSystemRequestRequestTypeDef

def get_value() -> DeleteFileSystemRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
    }
# DeleteFileSystemRequestRequestTypeDef definition

class DeleteFileSystemRequestRequestTypeDef(TypedDict):
    FileSystemId: str,

DeleteMountTargetRequestRequestTypeDef#

# DeleteMountTargetRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DeleteMountTargetRequestRequestTypeDef

def get_value() -> DeleteMountTargetRequestRequestTypeDef:
    return {
        "MountTargetId": ...,
    }
# DeleteMountTargetRequestRequestTypeDef definition

class DeleteMountTargetRequestRequestTypeDef(TypedDict):
    MountTargetId: str,

DeleteReplicationConfigurationRequestRequestTypeDef#

# DeleteReplicationConfigurationRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DeleteReplicationConfigurationRequestRequestTypeDef

def get_value() -> DeleteReplicationConfigurationRequestRequestTypeDef:
    return {
        "SourceFileSystemId": ...,
    }
# DeleteReplicationConfigurationRequestRequestTypeDef definition

class DeleteReplicationConfigurationRequestRequestTypeDef(TypedDict):
    SourceFileSystemId: str,

DeleteTagsRequestRequestTypeDef#

# DeleteTagsRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DeleteTagsRequestRequestTypeDef

def get_value() -> DeleteTagsRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
        "TagKeys": ...,
    }
# DeleteTagsRequestRequestTypeDef definition

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

DescribeAccessPointsRequestRequestTypeDef#

# DescribeAccessPointsRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeAccessPointsRequestRequestTypeDef

def get_value() -> DescribeAccessPointsRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
# DescribeAccessPointsRequestRequestTypeDef definition

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

DescribeAccountPreferencesRequestRequestTypeDef#

# DescribeAccountPreferencesRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeAccountPreferencesRequestRequestTypeDef

def get_value() -> DescribeAccountPreferencesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# DescribeAccountPreferencesRequestRequestTypeDef definition

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

ResourceIdPreferenceTypeDef#

# ResourceIdPreferenceTypeDef usage example

from mypy_boto3_efs.type_defs import ResourceIdPreferenceTypeDef

def get_value() -> ResourceIdPreferenceTypeDef:
    return {
        "ResourceIdType": ...,
    }
# ResourceIdPreferenceTypeDef definition

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

DescribeBackupPolicyRequestRequestTypeDef#

# DescribeBackupPolicyRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeBackupPolicyRequestRequestTypeDef

def get_value() -> DescribeBackupPolicyRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
    }
# DescribeBackupPolicyRequestRequestTypeDef definition

class DescribeBackupPolicyRequestRequestTypeDef(TypedDict):
    FileSystemId: str,

DescribeFileSystemPolicyRequestRequestTypeDef#

# DescribeFileSystemPolicyRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeFileSystemPolicyRequestRequestTypeDef

def get_value() -> DescribeFileSystemPolicyRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
    }
# DescribeFileSystemPolicyRequestRequestTypeDef definition

class DescribeFileSystemPolicyRequestRequestTypeDef(TypedDict):
    FileSystemId: str,

DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef#

# DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef

def get_value() -> DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef:
    return {
        "CreationToken": ...,
    }
# DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef definition

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

DescribeFileSystemsRequestRequestTypeDef#

# DescribeFileSystemsRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeFileSystemsRequestRequestTypeDef

def get_value() -> DescribeFileSystemsRequestRequestTypeDef:
    return {
        "MaxItems": ...,
    }
# DescribeFileSystemsRequestRequestTypeDef definition

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

DescribeLifecycleConfigurationRequestRequestTypeDef#

# DescribeLifecycleConfigurationRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeLifecycleConfigurationRequestRequestTypeDef

def get_value() -> DescribeLifecycleConfigurationRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
    }
# DescribeLifecycleConfigurationRequestRequestTypeDef definition

class DescribeLifecycleConfigurationRequestRequestTypeDef(TypedDict):
    FileSystemId: str,

DescribeMountTargetSecurityGroupsRequestRequestTypeDef#

# DescribeMountTargetSecurityGroupsRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeMountTargetSecurityGroupsRequestRequestTypeDef

def get_value() -> DescribeMountTargetSecurityGroupsRequestRequestTypeDef:
    return {
        "MountTargetId": ...,
    }
# DescribeMountTargetSecurityGroupsRequestRequestTypeDef definition

class DescribeMountTargetSecurityGroupsRequestRequestTypeDef(TypedDict):
    MountTargetId: str,

DescribeMountTargetSecurityGroupsResponseTypeDef#

# DescribeMountTargetSecurityGroupsResponseTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeMountTargetSecurityGroupsResponseTypeDef

def get_value() -> DescribeMountTargetSecurityGroupsResponseTypeDef:
    return {
        "SecurityGroups": ...,
        "ResponseMetadata": ...,
    }
# DescribeMountTargetSecurityGroupsResponseTypeDef definition

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

DescribeMountTargetsRequestDescribeMountTargetsPaginateTypeDef#

# DescribeMountTargetsRequestDescribeMountTargetsPaginateTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeMountTargetsRequestDescribeMountTargetsPaginateTypeDef

def get_value() -> DescribeMountTargetsRequestDescribeMountTargetsPaginateTypeDef:
    return {
        "FileSystemId": ...,
    }
# DescribeMountTargetsRequestDescribeMountTargetsPaginateTypeDef definition

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

DescribeMountTargetsRequestRequestTypeDef#

# DescribeMountTargetsRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeMountTargetsRequestRequestTypeDef

def get_value() -> DescribeMountTargetsRequestRequestTypeDef:
    return {
        "MaxItems": ...,
    }
# DescribeMountTargetsRequestRequestTypeDef definition

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

MountTargetDescriptionTypeDef#

# MountTargetDescriptionTypeDef usage example

from mypy_boto3_efs.type_defs import MountTargetDescriptionTypeDef

def get_value() -> MountTargetDescriptionTypeDef:
    return {
        "MountTargetId": ...,
        "FileSystemId": ...,
        "SubnetId": ...,
        "LifeCycleState": ...,
    }
# 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 usage example

from mypy_boto3_efs.type_defs import DescribeReplicationConfigurationsRequestRequestTypeDef

def get_value() -> DescribeReplicationConfigurationsRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
    }
# DescribeReplicationConfigurationsRequestRequestTypeDef definition

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

DescribeTagsRequestDescribeTagsPaginateTypeDef#

# DescribeTagsRequestDescribeTagsPaginateTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeTagsRequestDescribeTagsPaginateTypeDef

def get_value() -> DescribeTagsRequestDescribeTagsPaginateTypeDef:
    return {
        "FileSystemId": ...,
    }
# DescribeTagsRequestDescribeTagsPaginateTypeDef definition

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

DescribeTagsRequestRequestTypeDef#

# DescribeTagsRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeTagsRequestRequestTypeDef

def get_value() -> DescribeTagsRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
    }
# DescribeTagsRequestRequestTypeDef definition

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

DestinationTypeDef#

# DestinationTypeDef usage example

from mypy_boto3_efs.type_defs import DestinationTypeDef

def get_value() -> DestinationTypeDef:
    return {
        "Status": ...,
        "FileSystemId": ...,
        "Region": ...,
    }
# DestinationTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_efs.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

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

FileSystemSizeTypeDef#

# FileSystemSizeTypeDef usage example

from mypy_boto3_efs.type_defs import FileSystemSizeTypeDef

def get_value() -> FileSystemSizeTypeDef:
    return {
        "Value": ...,
    }
# FileSystemSizeTypeDef definition

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

FileSystemPolicyDescriptionTypeDef#

# FileSystemPolicyDescriptionTypeDef usage example

from mypy_boto3_efs.type_defs import FileSystemPolicyDescriptionTypeDef

def get_value() -> FileSystemPolicyDescriptionTypeDef:
    return {
        "FileSystemId": ...,
        "Policy": ...,
        "ResponseMetadata": ...,
    }
# FileSystemPolicyDescriptionTypeDef definition

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

LifecyclePolicyTypeDef#

# LifecyclePolicyTypeDef usage example

from mypy_boto3_efs.type_defs import LifecyclePolicyTypeDef

def get_value() -> LifecyclePolicyTypeDef:
    return {
        "TransitionToIA": ...,
    }
# LifecyclePolicyTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceId": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

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

ModifyMountTargetSecurityGroupsRequestRequestTypeDef#

# ModifyMountTargetSecurityGroupsRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import ModifyMountTargetSecurityGroupsRequestRequestTypeDef

def get_value() -> ModifyMountTargetSecurityGroupsRequestRequestTypeDef:
    return {
        "MountTargetId": ...,
    }
# ModifyMountTargetSecurityGroupsRequestRequestTypeDef definition

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

MountTargetDescriptionResponseMetadataTypeDef#

# MountTargetDescriptionResponseMetadataTypeDef usage example

from mypy_boto3_efs.type_defs import MountTargetDescriptionResponseMetadataTypeDef

def get_value() -> MountTargetDescriptionResponseMetadataTypeDef:
    return {
        "OwnerId": ...,
        "MountTargetId": ...,
        "FileSystemId": ...,
        "SubnetId": ...,
        "LifeCycleState": ...,
        "IpAddress": ...,
        "NetworkInterfaceId": ...,
        "AvailabilityZoneId": ...,
        "AvailabilityZoneName": ...,
        "VpcId": ...,
        "ResponseMetadata": ...,
    }
# MountTargetDescriptionResponseMetadataTypeDef definition

class MountTargetDescriptionResponseMetadataTypeDef(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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_efs.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
# PaginatorConfigTypeDef definition

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

PutAccountPreferencesRequestRequestTypeDef#

# PutAccountPreferencesRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import PutAccountPreferencesRequestRequestTypeDef

def get_value() -> PutAccountPreferencesRequestRequestTypeDef:
    return {
        "ResourceIdType": ...,
    }
# PutAccountPreferencesRequestRequestTypeDef definition

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

PutFileSystemPolicyRequestRequestTypeDef#

# PutFileSystemPolicyRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import PutFileSystemPolicyRequestRequestTypeDef

def get_value() -> PutFileSystemPolicyRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
        "Policy": ...,
    }
# PutFileSystemPolicyRequestRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_efs.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "TagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

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

UpdateFileSystemRequestRequestTypeDef#

# UpdateFileSystemRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import UpdateFileSystemRequestRequestTypeDef

def get_value() -> UpdateFileSystemRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
    }
# UpdateFileSystemRequestRequestTypeDef definition

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

CreateFileSystemRequestRequestTypeDef#

# CreateFileSystemRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import CreateFileSystemRequestRequestTypeDef

def get_value() -> CreateFileSystemRequestRequestTypeDef:
    return {
        "CreationToken": ...,
    }
# 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 usage example

from mypy_boto3_efs.type_defs import CreateTagsRequestRequestTypeDef

def get_value() -> CreateTagsRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
        "Tags": ...,
    }
# CreateTagsRequestRequestTypeDef definition

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

DescribeTagsResponseTypeDef#

# DescribeTagsResponseTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeTagsResponseTypeDef

def get_value() -> DescribeTagsResponseTypeDef:
    return {
        "Marker": ...,
        "Tags": ...,
        "NextMarker": ...,
        "ResponseMetadata": ...,
    }
# DescribeTagsResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_efs.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceResponseTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "Tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

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

BackupPolicyDescriptionTypeDef#

# BackupPolicyDescriptionTypeDef usage example

from mypy_boto3_efs.type_defs import BackupPolicyDescriptionTypeDef

def get_value() -> BackupPolicyDescriptionTypeDef:
    return {
        "BackupPolicy": ...,
        "ResponseMetadata": ...,
    }
# BackupPolicyDescriptionTypeDef definition

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

PutBackupPolicyRequestRequestTypeDef#

# PutBackupPolicyRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import PutBackupPolicyRequestRequestTypeDef

def get_value() -> PutBackupPolicyRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
        "BackupPolicy": ...,
    }
# PutBackupPolicyRequestRequestTypeDef definition

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

CreateReplicationConfigurationRequestRequestTypeDef#

# CreateReplicationConfigurationRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import CreateReplicationConfigurationRequestRequestTypeDef

def get_value() -> CreateReplicationConfigurationRequestRequestTypeDef:
    return {
        "SourceFileSystemId": ...,
        "Destinations": ...,
    }
# CreateReplicationConfigurationRequestRequestTypeDef definition

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

RootDirectoryTypeDef#

# RootDirectoryTypeDef usage example

from mypy_boto3_efs.type_defs import RootDirectoryTypeDef

def get_value() -> RootDirectoryTypeDef:
    return {
        "Path": ...,
    }
# RootDirectoryTypeDef definition

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

DescribeAccountPreferencesResponseTypeDef#

# DescribeAccountPreferencesResponseTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeAccountPreferencesResponseTypeDef

def get_value() -> DescribeAccountPreferencesResponseTypeDef:
    return {
        "ResourceIdPreference": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeAccountPreferencesResponseTypeDef definition

class DescribeAccountPreferencesResponseTypeDef(TypedDict):
    ResourceIdPreference: ResourceIdPreferenceTypeDef,  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourceIdPreferenceTypeDef
  2. See ResponseMetadataTypeDef

PutAccountPreferencesResponseTypeDef#

# PutAccountPreferencesResponseTypeDef usage example

from mypy_boto3_efs.type_defs import PutAccountPreferencesResponseTypeDef

def get_value() -> PutAccountPreferencesResponseTypeDef:
    return {
        "ResourceIdPreference": ...,
        "ResponseMetadata": ...,
    }
# PutAccountPreferencesResponseTypeDef definition

class PutAccountPreferencesResponseTypeDef(TypedDict):
    ResourceIdPreference: ResourceIdPreferenceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourceIdPreferenceTypeDef
  2. See ResponseMetadataTypeDef

DescribeMountTargetsResponseTypeDef#

# DescribeMountTargetsResponseTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeMountTargetsResponseTypeDef

def get_value() -> DescribeMountTargetsResponseTypeDef:
    return {
        "Marker": ...,
        "MountTargets": ...,
        "NextMarker": ...,
        "ResponseMetadata": ...,
    }
# DescribeMountTargetsResponseTypeDef definition

class DescribeMountTargetsResponseTypeDef(TypedDict):
    Marker: str,
    MountTargets: List[MountTargetDescriptionTypeDef],  # (1)
    NextMarker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MountTargetDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ReplicationConfigurationDescriptionResponseMetadataTypeDef#

# ReplicationConfigurationDescriptionResponseMetadataTypeDef usage example

from mypy_boto3_efs.type_defs import ReplicationConfigurationDescriptionResponseMetadataTypeDef

def get_value() -> ReplicationConfigurationDescriptionResponseMetadataTypeDef:
    return {
        "SourceFileSystemId": ...,
        "SourceFileSystemRegion": ...,
        "SourceFileSystemArn": ...,
        "OriginalSourceFileSystemArn": ...,
        "CreationTime": ...,
        "Destinations": ...,
        "ResponseMetadata": ...,
    }
# ReplicationConfigurationDescriptionResponseMetadataTypeDef definition

class ReplicationConfigurationDescriptionResponseMetadataTypeDef(TypedDict):
    SourceFileSystemId: str,
    SourceFileSystemRegion: str,
    SourceFileSystemArn: str,
    OriginalSourceFileSystemArn: str,
    CreationTime: datetime,
    Destinations: List[DestinationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DestinationTypeDef
  2. See ResponseMetadataTypeDef

ReplicationConfigurationDescriptionTypeDef#

# ReplicationConfigurationDescriptionTypeDef usage example

from mypy_boto3_efs.type_defs import ReplicationConfigurationDescriptionTypeDef

def get_value() -> ReplicationConfigurationDescriptionTypeDef:
    return {
        "SourceFileSystemId": ...,
        "SourceFileSystemRegion": ...,
        "SourceFileSystemArn": ...,
        "OriginalSourceFileSystemArn": ...,
        "CreationTime": ...,
        "Destinations": ...,
    }
# ReplicationConfigurationDescriptionTypeDef definition

class ReplicationConfigurationDescriptionTypeDef(TypedDict):
    SourceFileSystemId: str,
    SourceFileSystemRegion: str,
    SourceFileSystemArn: str,
    OriginalSourceFileSystemArn: str,
    CreationTime: datetime,
    Destinations: List[DestinationTypeDef],  # (1)
  1. See DestinationTypeDef

FileSystemDescriptionResponseMetadataTypeDef#

# FileSystemDescriptionResponseMetadataTypeDef usage example

from mypy_boto3_efs.type_defs import FileSystemDescriptionResponseMetadataTypeDef

def get_value() -> FileSystemDescriptionResponseMetadataTypeDef:
    return {
        "OwnerId": ...,
        "CreationToken": ...,
        "FileSystemId": ...,
        "FileSystemArn": ...,
        "CreationTime": ...,
        "LifeCycleState": ...,
        "Name": ...,
        "NumberOfMountTargets": ...,
        "SizeInBytes": ...,
        "PerformanceMode": ...,
        "Encrypted": ...,
        "KmsKeyId": ...,
        "ThroughputMode": ...,
        "ProvisionedThroughputInMibps": ...,
        "AvailabilityZoneName": ...,
        "AvailabilityZoneId": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# FileSystemDescriptionResponseMetadataTypeDef definition

class FileSystemDescriptionResponseMetadataTypeDef(TypedDict):
    OwnerId: str,
    CreationToken: str,
    FileSystemId: str,
    FileSystemArn: str,
    CreationTime: datetime,
    LifeCycleState: LifeCycleStateType,  # (1)
    Name: str,
    NumberOfMountTargets: int,
    SizeInBytes: FileSystemSizeTypeDef,  # (2)
    PerformanceMode: PerformanceModeType,  # (3)
    Encrypted: bool,
    KmsKeyId: str,
    ThroughputMode: ThroughputModeType,  # (4)
    ProvisionedThroughputInMibps: float,
    AvailabilityZoneName: str,
    AvailabilityZoneId: str,
    Tags: List[TagTypeDef],  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See LifeCycleStateType
  2. See FileSystemSizeTypeDef
  3. See PerformanceModeType
  4. See ThroughputModeType
  5. See TagTypeDef
  6. See ResponseMetadataTypeDef

FileSystemDescriptionTypeDef#

# FileSystemDescriptionTypeDef usage example

from mypy_boto3_efs.type_defs import FileSystemDescriptionTypeDef

def get_value() -> FileSystemDescriptionTypeDef:
    return {
        "OwnerId": ...,
        "CreationToken": ...,
        "FileSystemId": ...,
        "CreationTime": ...,
        "LifeCycleState": ...,
        "NumberOfMountTargets": ...,
        "SizeInBytes": ...,
        "PerformanceMode": ...,
        "Tags": ...,
    }
# FileSystemDescriptionTypeDef definition

class FileSystemDescriptionTypeDef(TypedDict):
    OwnerId: str,
    CreationToken: str,
    FileSystemId: str,
    CreationTime: datetime,
    LifeCycleState: LifeCycleStateType,  # (1)
    NumberOfMountTargets: int,
    SizeInBytes: FileSystemSizeTypeDef,  # (2)
    PerformanceMode: PerformanceModeType,  # (3)
    Tags: List[TagTypeDef],  # (5)
    FileSystemArn: NotRequired[str],
    Name: NotRequired[str],
    Encrypted: NotRequired[bool],
    KmsKeyId: NotRequired[str],
    ThroughputMode: NotRequired[ThroughputModeType],  # (4)
    ProvisionedThroughputInMibps: NotRequired[float],
    AvailabilityZoneName: NotRequired[str],
    AvailabilityZoneId: NotRequired[str],
  1. See LifeCycleStateType
  2. See FileSystemSizeTypeDef
  3. See PerformanceModeType
  4. See ThroughputModeType
  5. See TagTypeDef

LifecycleConfigurationDescriptionTypeDef#

# LifecycleConfigurationDescriptionTypeDef usage example

from mypy_boto3_efs.type_defs import LifecycleConfigurationDescriptionTypeDef

def get_value() -> LifecycleConfigurationDescriptionTypeDef:
    return {
        "LifecyclePolicies": ...,
        "ResponseMetadata": ...,
    }
# LifecycleConfigurationDescriptionTypeDef definition

class LifecycleConfigurationDescriptionTypeDef(TypedDict):
    LifecyclePolicies: List[LifecyclePolicyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LifecyclePolicyTypeDef
  2. See ResponseMetadataTypeDef

PutLifecycleConfigurationRequestRequestTypeDef#

# PutLifecycleConfigurationRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import PutLifecycleConfigurationRequestRequestTypeDef

def get_value() -> PutLifecycleConfigurationRequestRequestTypeDef:
    return {
        "FileSystemId": ...,
        "LifecyclePolicies": ...,
    }
# PutLifecycleConfigurationRequestRequestTypeDef definition

class PutLifecycleConfigurationRequestRequestTypeDef(TypedDict):
    FileSystemId: str,
    LifecyclePolicies: Sequence[LifecyclePolicyTypeDef],  # (1)
  1. See LifecyclePolicyTypeDef

AccessPointDescriptionResponseMetadataTypeDef#

# AccessPointDescriptionResponseMetadataTypeDef usage example

from mypy_boto3_efs.type_defs import AccessPointDescriptionResponseMetadataTypeDef

def get_value() -> AccessPointDescriptionResponseMetadataTypeDef:
    return {
        "ClientToken": ...,
        "Name": ...,
        "Tags": ...,
        "AccessPointId": ...,
        "AccessPointArn": ...,
        "FileSystemId": ...,
        "PosixUser": ...,
        "RootDirectory": ...,
        "OwnerId": ...,
        "LifeCycleState": ...,
        "ResponseMetadata": ...,
    }
# AccessPointDescriptionResponseMetadataTypeDef definition

class AccessPointDescriptionResponseMetadataTypeDef(TypedDict):
    ClientToken: str,
    Name: str,
    Tags: List[TagTypeDef],  # (1)
    AccessPointId: str,
    AccessPointArn: str,
    FileSystemId: str,
    PosixUser: PosixUserTypeDef,  # (2)
    RootDirectory: RootDirectoryTypeDef,  # (3)
    OwnerId: str,
    LifeCycleState: LifeCycleStateType,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See TagTypeDef
  2. See PosixUserTypeDef
  3. See RootDirectoryTypeDef
  4. See LifeCycleStateType
  5. See ResponseMetadataTypeDef

AccessPointDescriptionTypeDef#

# AccessPointDescriptionTypeDef usage example

from mypy_boto3_efs.type_defs import AccessPointDescriptionTypeDef

def get_value() -> AccessPointDescriptionTypeDef:
    return {
        "ClientToken": ...,
    }
# AccessPointDescriptionTypeDef definition

class AccessPointDescriptionTypeDef(TypedDict):
    ClientToken: NotRequired[str],
    Name: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)
    AccessPointId: NotRequired[str],
    AccessPointArn: NotRequired[str],
    FileSystemId: NotRequired[str],
    PosixUser: NotRequired[PosixUserTypeDef],  # (2)
    RootDirectory: NotRequired[RootDirectoryTypeDef],  # (3)
    OwnerId: NotRequired[str],
    LifeCycleState: NotRequired[LifeCycleStateType],  # (4)
  1. See TagTypeDef
  2. See PosixUserTypeDef
  3. See RootDirectoryTypeDef
  4. See LifeCycleStateType

CreateAccessPointRequestRequestTypeDef#

# CreateAccessPointRequestRequestTypeDef usage example

from mypy_boto3_efs.type_defs import CreateAccessPointRequestRequestTypeDef

def get_value() -> CreateAccessPointRequestRequestTypeDef:
    return {
        "ClientToken": ...,
        "FileSystemId": ...,
    }
# CreateAccessPointRequestRequestTypeDef definition

class CreateAccessPointRequestRequestTypeDef(TypedDict):
    ClientToken: str,
    FileSystemId: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    PosixUser: NotRequired[PosixUserTypeDef],  # (2)
    RootDirectory: NotRequired[RootDirectoryTypeDef],  # (3)
  1. See TagTypeDef
  2. See PosixUserTypeDef
  3. See RootDirectoryTypeDef

DescribeReplicationConfigurationsResponseTypeDef#

# DescribeReplicationConfigurationsResponseTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeReplicationConfigurationsResponseTypeDef

def get_value() -> DescribeReplicationConfigurationsResponseTypeDef:
    return {
        "Replications": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeReplicationConfigurationsResponseTypeDef definition

class DescribeReplicationConfigurationsResponseTypeDef(TypedDict):
    Replications: List[ReplicationConfigurationDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationConfigurationDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DescribeFileSystemsResponseTypeDef#

# DescribeFileSystemsResponseTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeFileSystemsResponseTypeDef

def get_value() -> DescribeFileSystemsResponseTypeDef:
    return {
        "Marker": ...,
        "FileSystems": ...,
        "NextMarker": ...,
        "ResponseMetadata": ...,
    }
# DescribeFileSystemsResponseTypeDef definition

class DescribeFileSystemsResponseTypeDef(TypedDict):
    Marker: str,
    FileSystems: List[FileSystemDescriptionTypeDef],  # (1)
    NextMarker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FileSystemDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DescribeAccessPointsResponseTypeDef#

# DescribeAccessPointsResponseTypeDef usage example

from mypy_boto3_efs.type_defs import DescribeAccessPointsResponseTypeDef

def get_value() -> DescribeAccessPointsResponseTypeDef:
    return {
        "AccessPoints": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeAccessPointsResponseTypeDef definition

class DescribeAccessPointsResponseTypeDef(TypedDict):
    AccessPoints: List[AccessPointDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccessPointDescriptionTypeDef
  2. See ResponseMetadataTypeDef