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
# EFSClient usage example
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.
# Exceptions.exceptions usage example
client = boto3.client("efs")
try:
do_something(client)
except (
client.exceptions.AccessPointAlreadyExists,
client.exceptions.AccessPointLimitExceeded,
client.exceptions.AccessPointNotFound,
client.exceptions.AvailabilityZonesMismatch,
client.exceptions.BadRequest,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.DependencyTimeout,
client.exceptions.FileSystemAlreadyExists,
client.exceptions.FileSystemInUse,
client.exceptions.FileSystemLimitExceeded,
client.exceptions.FileSystemNotFound,
client.exceptions.IncorrectFileSystemLifeCycleState,
client.exceptions.IncorrectMountTargetState,
client.exceptions.InsufficientThroughputCapacity,
client.exceptions.InternalServerError,
client.exceptions.InvalidPolicyException,
client.exceptions.IpAddressInUse,
client.exceptions.MountTargetConflict,
client.exceptions.MountTargetNotFound,
client.exceptions.NetworkInterfaceLimitExceeded,
client.exceptions.NoFreeAddressesInSubnet,
client.exceptions.PolicyNotFound,
client.exceptions.ReplicationAlreadyExists,
client.exceptions.ReplicationNotFound,
client.exceptions.SecurityGroupLimitExceeded,
client.exceptions.SecurityGroupNotFound,
client.exceptions.SubnetNotFound,
client.exceptions.ThrottlingException,
client.exceptions.ThroughputLimitExceeded,
client.exceptions.TooManyRequests,
client.exceptions.UnsupportedAvailabilityZone,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
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
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("efs").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_access_point#
Creates an EFS access point.
Type annotations and code completion for boto3.client("efs").create_access_point
method.
boto3 documentation
# create_access_point method definition
def create_access_point(
self,
*,
ClientToken: str,
FileSystemId: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
PosixUser: PosixUserTypeDef = ..., # (2)
RootDirectory: RootDirectoryTypeDef = ..., # (3)
) -> AccessPointDescriptionResponseTypeDef: # (4)
...
- See TagTypeDef
- See PosixUserTypeDef
- See RootDirectoryTypeDef
- See AccessPointDescriptionResponseTypeDef
# create_access_point method usage example with argument unpacking
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
# create_file_system method definition
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)
) -> FileSystemDescriptionResponseTypeDef: # (4)
...
- See PerformanceModeType
- See ThroughputModeType
- See TagTypeDef
- See FileSystemDescriptionResponseTypeDef
# create_file_system method usage example with argument unpacking
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
# create_mount_target method definition
def create_mount_target(
self,
*,
FileSystemId: str,
SubnetId: str,
IpAddress: str = ...,
SecurityGroups: Sequence[str] = ...,
) -> MountTargetDescriptionResponseTypeDef: # (1)
...
# create_mount_target method usage example with argument unpacking
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
# create_replication_configuration method definition
def create_replication_configuration(
self,
*,
SourceFileSystemId: str,
Destinations: Sequence[DestinationToCreateTypeDef], # (1)
) -> ReplicationConfigurationDescriptionResponseTypeDef: # (2)
...
# create_replication_configuration method usage example with argument unpacking
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
# create_tags method definition
def create_tags(
self,
*,
FileSystemId: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# create_tags method usage example with argument unpacking
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
# delete_access_point method definition
def delete_access_point(
self,
*,
AccessPointId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_access_point method usage example with argument unpacking
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
# delete_file_system method definition
def delete_file_system(
self,
*,
FileSystemId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_file_system method usage example with argument unpacking
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
# delete_file_system_policy method definition
def delete_file_system_policy(
self,
*,
FileSystemId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_file_system_policy method usage example with argument unpacking
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
# delete_mount_target method definition
def delete_mount_target(
self,
*,
MountTargetId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_mount_target method usage example with argument unpacking
kwargs: DeleteMountTargetRequestRequestTypeDef = { # (1)
"MountTargetId": ...,
}
parent.delete_mount_target(**kwargs)
delete_replication_configuration#
Deletes a replication configuration.
Type annotations and code completion for boto3.client("efs").delete_replication_configuration
method.
boto3 documentation
# delete_replication_configuration method definition
def delete_replication_configuration(
self,
*,
SourceFileSystemId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_replication_configuration method usage example with argument unpacking
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
# delete_tags method definition
def delete_tags(
self,
*,
FileSystemId: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_tags method usage example with argument unpacking
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
# describe_access_points method definition
def describe_access_points(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
AccessPointId: str = ...,
FileSystemId: str = ...,
) -> DescribeAccessPointsResponseTypeDef: # (1)
...
# describe_access_points method usage example with argument unpacking
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
# describe_account_preferences method definition
def describe_account_preferences(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeAccountPreferencesResponseTypeDef: # (1)
...
# describe_account_preferences method usage example with argument unpacking
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
# describe_backup_policy method definition
def describe_backup_policy(
self,
*,
FileSystemId: str,
) -> BackupPolicyDescriptionTypeDef: # (1)
...
# describe_backup_policy method usage example with argument unpacking
kwargs: DescribeBackupPolicyRequestRequestTypeDef = { # (1)
"FileSystemId": ...,
}
parent.describe_backup_policy(**kwargs)