EFSClient
Auto-generated documentation for EFS type annotations stubs module mypy-boto3-efs.
EFSClient
Type annotations and code completion for boto3.client("efs")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_efs.client import EFSClient
def get_efs_client() -> EFSClient:
return Session().client("efs")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("efs").exceptions
structure.
client = boto3.client("efs")
try:
do_something(client)
except (
client.AccessPointAlreadyExists,
client.AccessPointLimitExceeded,
client.AccessPointNotFound,
client.AvailabilityZonesMismatch,
client.BadRequest,
client.ClientError,
client.DependencyTimeout,
client.FileSystemAlreadyExists,
client.FileSystemInUse,
client.FileSystemLimitExceeded,
client.FileSystemNotFound,
client.IncorrectFileSystemLifeCycleState,
client.IncorrectMountTargetState,
client.InsufficientThroughputCapacity,
client.InternalServerError,
client.InvalidPolicyException,
client.IpAddressInUse,
client.MountTargetConflict,
client.MountTargetNotFound,
client.NetworkInterfaceLimitExceeded,
client.NoFreeAddressesInSubnet,
client.PolicyNotFound,
client.ReplicationNotFound,
client.SecurityGroupLimitExceeded,
client.SecurityGroupNotFound,
client.SubnetNotFound,
client.ThrottlingException,
client.ThroughputLimitExceeded,
client.TooManyRequests,
client.UnsupportedAvailabilityZone,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_efs.client import Exceptions
def handle_error(exc: Exceptions.AccessPointAlreadyExists) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("efs").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("efs").close
method.
boto3 documentation
create_access_point
Creates an EFS access point.
Type annotations and code completion for boto3.client("efs").create_access_point
method.
boto3 documentation
def create_access_point(
self,
*,
ClientToken: str,
FileSystemId: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
PosixUser: PosixUserTypeDef = ..., # (2)
RootDirectory: RootDirectoryTypeDef = ..., # (3)
) -> AccessPointDescriptionResponseMetadataTypeDef: # (4)
...
- See TagTypeDef
- See PosixUserTypeDef
- See RootDirectoryTypeDef
- See AccessPointDescriptionResponseMetadataTypeDef
kwargs: CreateAccessPointRequestRequestTypeDef = { # (1)
"ClientToken": ...,
"FileSystemId": ...,
}
parent.create_access_point(**kwargs)
create_file_system
Creates a new, empty file system.
Type annotations and code completion for boto3.client("efs").create_file_system
method.
boto3 documentation
def create_file_system(
self,
*,
CreationToken: str,
PerformanceMode: PerformanceModeType = ..., # (1)
Encrypted: bool = ...,
KmsKeyId: str = ...,
ThroughputMode: ThroughputModeType = ..., # (2)
ProvisionedThroughputInMibps: float = ...,
AvailabilityZoneName: str = ...,
Backup: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> FileSystemDescriptionResponseMetadataTypeDef: # (4)
...
- See PerformanceModeType
- See ThroughputModeType
- See TagTypeDef
- See FileSystemDescriptionResponseMetadataTypeDef
kwargs: CreateFileSystemRequestRequestTypeDef = { # (1)
"CreationToken": ...,
}
parent.create_file_system(**kwargs)
create_mount_target
Creates a mount target for a file system.
Type annotations and code completion for boto3.client("efs").create_mount_target
method.
boto3 documentation
def create_mount_target(
self,
*,
FileSystemId: str,
SubnetId: str,
IpAddress: str = ...,
SecurityGroups: Sequence[str] = ...,
) -> MountTargetDescriptionResponseMetadataTypeDef: # (1)
...
kwargs: CreateMountTargetRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
"SubnetId": ...,
}
parent.create_mount_target(**kwargs)
create_replication_configuration
Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system.
Type annotations and code completion for boto3.client("efs").create_replication_configuration
method.
boto3 documentation
def create_replication_configuration(
self,
*,
SourceFileSystemId: str,
Destinations: Sequence[DestinationToCreateTypeDef], # (1)
) -> ReplicationConfigurationDescriptionResponseMetadataTypeDef: # (2)
...
kwargs: CreateReplicationConfigurationRequestRequestTypeDef = { # (1)
"SourceFileSystemId": ...,
"Destinations": ...,
}
parent.create_replication_configuration(**kwargs)
create_tags
.
Type annotations and code completion for boto3.client("efs").create_tags
method.
boto3 documentation
def create_tags(
self,
*,
FileSystemId: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: CreateTagsRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
"Tags": ...,
}
parent.create_tags(**kwargs)
delete_access_point
Deletes the specified access point.
Type annotations and code completion for boto3.client("efs").delete_access_point
method.
boto3 documentation
def delete_access_point(
self,
*,
AccessPointId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAccessPointRequestRequestTypeDef = { # (1)
"AccessPointId": ...,
}
parent.delete_access_point(**kwargs)
delete_file_system
Deletes a file system, permanently severing access to its contents.
Type annotations and code completion for boto3.client("efs").delete_file_system
method.
boto3 documentation
def delete_file_system(
self,
*,
FileSystemId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteFileSystemRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
}
parent.delete_file_system(**kwargs)
delete_file_system_policy
Deletes the FileSystemPolicy
for the specified file system.
Type annotations and code completion for boto3.client("efs").delete_file_system_policy
method.
boto3 documentation
def delete_file_system_policy(
self,
*,
FileSystemId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteFileSystemPolicyRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
}
parent.delete_file_system_policy(**kwargs)
delete_mount_target
Deletes the specified mount target.
Type annotations and code completion for boto3.client("efs").delete_mount_target
method.
boto3 documentation
def delete_mount_target(
self,
*,
MountTargetId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteMountTargetRequestRequestTypeDef = { # (1)
"MountTargetId": ...,
}
parent.delete_mount_target(**kwargs)
delete_replication_configuration
Deletes an existing replication configuration.
Type annotations and code completion for boto3.client("efs").delete_replication_configuration
method.
boto3 documentation
def delete_replication_configuration(
self,
*,
SourceFileSystemId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteReplicationConfigurationRequestRequestTypeDef = { # (1)
"SourceFileSystemId": ...,
}
parent.delete_replication_configuration(**kwargs)
delete_tags
.
Type annotations and code completion for boto3.client("efs").delete_tags
method.
boto3 documentation
def delete_tags(
self,
*,
FileSystemId: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteTagsRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
"TagKeys": ...,
}
parent.delete_tags(**kwargs)
describe_access_points
Returns the description of a specific Amazon EFS access point if the
AccessPointId
is provided.
Type annotations and code completion for boto3.client("efs").describe_access_points
method.
boto3 documentation
def describe_access_points(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
AccessPointId: str = ...,
FileSystemId: str = ...,
) -> DescribeAccessPointsResponseTypeDef: # (1)
...
kwargs: DescribeAccessPointsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.describe_access_points(**kwargs)
describe_account_preferences
Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("efs").describe_account_preferences
method.
boto3 documentation
def describe_account_preferences(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeAccountPreferencesResponseTypeDef: # (1)
...
kwargs: DescribeAccountPreferencesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.describe_account_preferences(**kwargs)
describe_backup_policy
Returns the backup policy for the specified EFS file system.
Type annotations and code completion for boto3.client("efs").describe_backup_policy
method.
boto3 documentation
def describe_backup_policy(
self,
*,
FileSystemId: str,
) -> BackupPolicyDescriptionTypeDef: # (1)
...
kwargs: DescribeBackupPolicyRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
}
parent.describe_backup_policy(**kwargs)
describe_file_system_policy
Returns the FileSystemPolicy
for the specified EFS file system.
Type annotations and code completion for boto3.client("efs").describe_file_system_policy
method.
boto3 documentation
def describe_file_system_policy(
self,
*,
FileSystemId: str,
) -> FileSystemPolicyDescriptionTypeDef: # (1)
...
kwargs: DescribeFileSystemPolicyRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
}
parent.describe_file_system_policy(**kwargs)
describe_file_systems
Returns the description of a specific Amazon EFS file system if either the file
system CreationToken
or the FileSystemId
is provided.
Type annotations and code completion for boto3.client("efs").describe_file_systems
method.
boto3 documentation
def describe_file_systems(
self,
*,
MaxItems: int = ...,
Marker: str = ...,
CreationToken: str = ...,
FileSystemId: str = ...,
) -> DescribeFileSystemsResponseTypeDef: # (1)
...
kwargs: DescribeFileSystemsRequestRequestTypeDef = { # (1)
"MaxItems": ...,
}
parent.describe_file_systems(**kwargs)
describe_lifecycle_configuration
Returns the current LifecycleConfiguration
object for the specified Amazon EFS
file system.
Type annotations and code completion for boto3.client("efs").describe_lifecycle_configuration
method.
boto3 documentation
def describe_lifecycle_configuration(
self,
*,
FileSystemId: str,
) -> LifecycleConfigurationDescriptionTypeDef: # (1)
...
kwargs: DescribeLifecycleConfigurationRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
}
parent.describe_lifecycle_configuration(**kwargs)
describe_mount_target_security_groups
Returns the security groups currently in effect for a mount target.
Type annotations and code completion for boto3.client("efs").describe_mount_target_security_groups
method.
boto3 documentation
def describe_mount_target_security_groups(
self,
*,
MountTargetId: str,
) -> DescribeMountTargetSecurityGroupsResponseTypeDef: # (1)
...
kwargs: DescribeMountTargetSecurityGroupsRequestRequestTypeDef = { # (1)
"MountTargetId": ...,
}
parent.describe_mount_target_security_groups(**kwargs)
describe_mount_targets
Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
Type annotations and code completion for boto3.client("efs").describe_mount_targets
method.
boto3 documentation
def describe_mount_targets(
self,
*,
MaxItems: int = ...,
Marker: str = ...,
FileSystemId: str = ...,
MountTargetId: str = ...,
AccessPointId: str = ...,
) -> DescribeMountTargetsResponseTypeDef: # (1)
...
kwargs: DescribeMountTargetsRequestRequestTypeDef = { # (1)
"MaxItems": ...,
}
parent.describe_mount_targets(**kwargs)
describe_replication_configurations
Retrieves the replication configuration for a specific file system.
Type annotations and code completion for boto3.client("efs").describe_replication_configurations
method.
boto3 documentation
def describe_replication_configurations(
self,
*,
FileSystemId: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeReplicationConfigurationsResponseTypeDef: # (1)
...
kwargs: DescribeReplicationConfigurationsRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
}
parent.describe_replication_configurations(**kwargs)
describe_tags
.
Type annotations and code completion for boto3.client("efs").describe_tags
method.
boto3 documentation
def describe_tags(
self,
*,
FileSystemId: str,
MaxItems: int = ...,
Marker: str = ...,
) -> DescribeTagsResponseTypeDef: # (1)
...
kwargs: DescribeTagsRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
}
parent.describe_tags(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("efs").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_tags_for_resource
Lists all tags for a top-level EFS resource.
Type annotations and code completion for boto3.client("efs").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.list_tags_for_resource(**kwargs)
modify_mount_target_security_groups
Modifies the set of security groups in effect for a mount target.
Type annotations and code completion for boto3.client("efs").modify_mount_target_security_groups
method.
boto3 documentation
def modify_mount_target_security_groups(
self,
*,
MountTargetId: str,
SecurityGroups: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: ModifyMountTargetSecurityGroupsRequestRequestTypeDef = { # (1)
"MountTargetId": ...,
}
parent.modify_mount_target_security_groups(**kwargs)
put_account_preferences
Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources.
Type annotations and code completion for boto3.client("efs").put_account_preferences
method.
boto3 documentation
def put_account_preferences(
self,
*,
ResourceIdType: ResourceIdTypeType, # (1)
) -> PutAccountPreferencesResponseTypeDef: # (2)
...
kwargs: PutAccountPreferencesRequestRequestTypeDef = { # (1)
"ResourceIdType": ...,
}
parent.put_account_preferences(**kwargs)
put_backup_policy
Updates the file system's backup policy.
Type annotations and code completion for boto3.client("efs").put_backup_policy
method.
boto3 documentation
def put_backup_policy(
self,
*,
FileSystemId: str,
BackupPolicy: BackupPolicyTypeDef, # (1)
) -> BackupPolicyDescriptionTypeDef: # (2)
...
kwargs: PutBackupPolicyRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
"BackupPolicy": ...,
}
parent.put_backup_policy(**kwargs)
put_file_system_policy
Applies an Amazon EFS FileSystemPolicy
to an Amazon EFS file system.
Type annotations and code completion for boto3.client("efs").put_file_system_policy
method.
boto3 documentation
def put_file_system_policy(
self,
*,
FileSystemId: str,
Policy: str,
BypassPolicyLockoutSafetyCheck: bool = ...,
) -> FileSystemPolicyDescriptionTypeDef: # (1)
...
kwargs: PutFileSystemPolicyRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
"Policy": ...,
}
parent.put_file_system_policy(**kwargs)
put_lifecycle_configuration
Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering.
Type annotations and code completion for boto3.client("efs").put_lifecycle_configuration
method.
boto3 documentation
def put_lifecycle_configuration(
self,
*,
FileSystemId: str,
LifecyclePolicies: Sequence[LifecyclePolicyTypeDef], # (1)
) -> LifecycleConfigurationDescriptionTypeDef: # (2)
...
kwargs: PutLifecycleConfigurationRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
"LifecyclePolicies": ...,
}
parent.put_lifecycle_configuration(**kwargs)
tag_resource
Creates a tag for an EFS resource.
Type annotations and code completion for boto3.client("efs").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceId: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from an EFS resource.
Type annotations and code completion for boto3.client("efs").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceId: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_file_system
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
Type annotations and code completion for boto3.client("efs").update_file_system
method.
boto3 documentation
def update_file_system(
self,
*,
FileSystemId: str,
ThroughputMode: ThroughputModeType = ..., # (1)
ProvisionedThroughputInMibps: float = ...,
) -> FileSystemDescriptionResponseMetadataTypeDef: # (2)
...
kwargs: UpdateFileSystemRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
}
parent.update_file_system(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("efs").get_paginator
method with overloads.
client.get_paginator("describe_file_systems")
-> DescribeFileSystemsPaginatorclient.get_paginator("describe_mount_targets")
-> DescribeMountTargetsPaginatorclient.get_paginator("describe_tags")
-> DescribeTagsPaginator