Table of Contents
EFS.Client¶A low-level client representing Amazon Elastic File System (EFS)
Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so that your applications have the storage they need, when they need it. For more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide .
import boto3
client = boto3.client('efs')
These are the available methods:
can_paginate()close()create_access_point()create_file_system()create_mount_target()create_replication_configuration()create_tags()delete_access_point()delete_file_system()delete_file_system_policy()delete_mount_target()delete_replication_configuration()delete_tags()describe_access_points()describe_account_preferences()describe_backup_policy()describe_file_system_policy()describe_file_systems()describe_lifecycle_configuration()describe_mount_target_security_groups()describe_mount_targets()describe_replication_configurations()describe_tags()get_paginator()get_waiter()list_tags_for_resource()modify_mount_target_security_groups()put_account_preferences()put_backup_policy()put_file_system_policy()put_lifecycle_configuration()tag_resource()untag_resource()update_file_system()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_access_point(**kwargs)¶Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access points .
This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
See also: AWS API Documentation
Request Syntax
response = client.create_access_point(
ClientToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FileSystemId='string',
PosixUser={
'Uid': 123,
'Gid': 123,
'SecondaryGids': [
123,
]
},
RootDirectory={
'Path': 'string',
'CreationInfo': {
'OwnerUid': 123,
'OwnerGid': 123,
'Permissions': 'string'
}
}
)
[REQUIRED]
A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
This field is autopopulated if not provided.
Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide .
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
The tag key (String). The key can't start with aws: .
The value of the tag key.
[REQUIRED]
The ID of the EFS file system that the access point provides access to.
The operating system user and group applied to all file system requests made using the access point.
The POSIX user ID used for all file system operations using this access point.
The POSIX group ID used for all file system operations using this access point.
Secondary POSIX group IDs used for all file system operations using this access point.
Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory > Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory , you must provide the Path , and the CreationInfo .
Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.
Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo .
(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory . If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo , you must provide values for all properties.
Warning
If you do not provide CreationInfo and the specified RootDirectory > Path does not exist, attempts to mount the file system using the access point will fail.
Specifies the POSIX user ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).
Specifies the POSIX group ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).
Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file's mode bits.
dict
Response Syntax
{
'ClientToken': 'string',
'Name': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AccessPointId': 'string',
'AccessPointArn': 'string',
'FileSystemId': 'string',
'PosixUser': {
'Uid': 123,
'Gid': 123,
'SecondaryGids': [
123,
]
},
'RootDirectory': {
'Path': 'string',
'CreationInfo': {
'OwnerUid': 123,
'OwnerGid': 123,
'Permissions': 'string'
}
},
'OwnerId': 'string',
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error'
}
Response Structure
(dict) --
Provides a description of an EFS file system access point.
ClientToken (string) --
The opaque string specified in the request to ensure idempotent creation.
Name (string) --
The name of the access point. This is the value of the Name tag.
Tags (list) --
The tags associated with the access point, presented as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
AccessPointId (string) --
The ID of the access point, assigned by Amazon EFS.
AccessPointArn (string) --
The unique Amazon Resource Name (ARN) associated with the access point.
FileSystemId (string) --
The ID of the EFS file system that the access point applies to.
PosixUser (dict) --
The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
Uid (integer) --
The POSIX user ID used for all file system operations using this access point.
Gid (integer) --
The POSIX group ID used for all file system operations using this access point.
SecondaryGids (list) --
Secondary POSIX group IDs used for all file system operations using this access point.
RootDirectory (dict) --
The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
Path (string) --
Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo .
CreationInfo (dict) --
(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory . If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo , you must provide values for all properties.
Warning
If you do not provide CreationInfo and the specified RootDirectory > Path does not exist, attempts to mount the file system using the access point will fail.
OwnerUid (integer) --
Specifies the POSIX user ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).
OwnerGid (integer) --
Specifies the POSIX group ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).
Permissions (string) --
Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file's mode bits.
OwnerId (string) --
Identified the Amazon Web Services account that owns the access point resource.
LifeCycleState (string) --
Identifies the lifecycle phase of the access point.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.AccessPointAlreadyExistsEFS.Client.exceptions.IncorrectFileSystemLifeCycleStateEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.AccessPointLimitExceededEFS.Client.exceptions.ThrottlingExceptioncreate_file_system(**kwargs)¶Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following:
creating .Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.
Note
For basic use cases, you can use a randomly generated UUID for the creation token.
The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.
For more information, see Creating a file system in the Amazon EFS User Guide .
Note
The CreateFileSystem call returns while the file system's lifecycle state is still creating . You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.
This operation accepts an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS performance modes .
You can set the throughput mode for the file system using the ThroughputMode parameter.
After the file system is fully created, Amazon EFS sets its lifecycle state to available , at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget . You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works .
This operation requires permissions for the elasticfilesystem:CreateFileSystem action.
See also: AWS API Documentation
Request Syntax
response = client.create_file_system(
CreationToken='string',
PerformanceMode='generalPurpose'|'maxIO',
Encrypted=True|False,
KmsKeyId='string',
ThroughputMode='bursting'|'provisioned',
ProvisionedThroughputInMibps=123.0,
AvailabilityZoneName='string',
Backup=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
This field is autopopulated if not provided.
The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created.
Note
The maxIO mode is not supported on file systems using One Zone storage classes.
/aws/elasticfilesystem , is used to protect the encrypted file system.The ID of the KMS key that you want to use to protect the encrypted file system. This parameter is required only if you want to use a non-default KMS key. If this parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a KMS key ID using the following formats:
1234abcd-12ab-34cd-56ef-1234567890ab .arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .alias/projectKey1 .arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .If you use KmsKeyId , you must set the CreateFileSystemRequest$Encrypted parameter to true.
Warning
EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems.
Specifies the throughput mode for the file system, either bursting or provisioned . If you set ThroughputMode to provisioned , you must also set a value for ProvisionedThroughputInMibps . After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .
Default is bursting .
ThroughputMode is set to provisioned . The upper limit for throughput is 1024 MiB/s. To increase this limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide .Used to create a file system that uses One Zone storage classes. It specifies the Amazon Web Services Availability Zone in which to create the file system. Use the format us-east-1a to specify the Availability Zone. For more information about One Zone storage classes, see Using EFS storage classes in the Amazon EFS User Guide .
Note
One Zone storage classes are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to true to enable automatic backups. If you are creating a file system that uses One Zone storage classes, automatic backups are enabled by default. For more information, see Automatic backups in the Amazon EFS User Guide .
Default is false . However, if you specify an AvailabilityZoneName , the default is true .
Note
Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. Each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide .
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
The tag key (String). The key can't start with aws: .
The value of the tag key.
dict
Response Syntax
{
'OwnerId': 'string',
'CreationToken': 'string',
'FileSystemId': 'string',
'FileSystemArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
'Name': 'string',
'NumberOfMountTargets': 123,
'SizeInBytes': {
'Value': 123,
'Timestamp': datetime(2015, 1, 1),
'ValueInIA': 123,
'ValueInStandard': 123
},
'PerformanceMode': 'generalPurpose'|'maxIO',
'Encrypted': True|False,
'KmsKeyId': 'string',
'ThroughputMode': 'bursting'|'provisioned',
'ProvisionedThroughputInMibps': 123.0,
'AvailabilityZoneName': 'string',
'AvailabilityZoneId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
A description of the file system.
OwnerId (string) --
The Amazon Web Services account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
CreationToken (string) --
The opaque string specified in the request.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
FileSystemArn (string) --
The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:*region* :*account-id* :file-system/*file-system-id* `` . Example with sample data: ``arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
CreationTime (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
LifeCycleState (string) --
The lifecycle phase of the file system.
Name (string) --
You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem . If the file system has a Name tag, Amazon EFS returns the value in this field.
NumberOfMountTargets (integer) --
The current number of mount targets that the file system has. For more information, see CreateMountTarget .
SizeInBytes (dict) --
The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.
Value (integer) --
The latest known metered size (in bytes) of data stored in the file system.
Timestamp (datetime) --
The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.
ValueInIA (integer) --
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
ValueInStandard (integer) --
The latest known metered size (in bytes) of data stored in the Standard storage class.
PerformanceMode (string) --
The performance mode of the file system.
Encrypted (boolean) --
A Boolean value that, if true, indicates that the file system is encrypted.
KmsKeyId (string) --
The ID of an KMS key used to protect the encrypted file system.
ThroughputMode (string) --
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide .
ProvisionedThroughputInMibps (float) --
The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned .
AvailabilityZoneName (string) --
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide .
AvailabilityZoneId (string) --
The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.
Tags (list) --
The tags associated with the file system, presented as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemAlreadyExistsEFS.Client.exceptions.FileSystemLimitExceededEFS.Client.exceptions.InsufficientThroughputCapacityEFS.Client.exceptions.ThroughputLimitExceededEFS.Client.exceptions.UnsupportedAvailabilityZoneExamples
This operation creates a new, encrypted file system with automatic backups enabled, and the default generalpurpose performance mode.
response = client.create_file_system(
Backup=True,
CreationToken='tokenstring',
Encrypted=True,
PerformanceMode='generalPurpose',
Tags=[
{
'Key': 'Name',
'Value': 'MyFileSystem',
},
],
)
print(response)
Expected Output:
{
'CreationTime': datetime(2016, 12, 15, 22, 38, 44, 3, 350, 0),
'CreationToken': 'tokenstring',
'Encrypted': True,
'FileSystemId': 'fs-01234567',
'LifeCycleState': 'creating',
'NumberOfMountTargets': 0,
'OwnerId': '012345678912',
'PerformanceMode': 'generalPurpose',
'SizeInBytes': {
'Value': 0,
},
'Tags': [
{
'Key': 'Name',
'Value': 'MyFileSystem',
},
],
'ResponseMetadata': {
'...': '...',
},
}
create_mount_target(**kwargs)¶Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.
You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system.
You can create only one mount target for an EFS file system using One Zone storage classes. You must create that mount target in the same Availability Zone in which the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this information. Use the subnetId associated with the file system's Availability Zone when creating the mount target.
For more information, see Amazon EFS: How it Works .
To create a mount target for a file system, the file system's lifecycle state must be available . For more information, see DescribeFileSystems .
In the request, provide the following:
After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress . You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview .
Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:
If the request satisfies the requirements, Amazon EFS does the following:
IpAddress , Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).SecurityGroups , this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.Mount target *fsmt-id* for file system *fs-id* `` where `` *fsmt-id* `` is the mount target ID, and `` *fs-id* `` is the ``FileSystemId .requesterManaged property of the network interface to true , and the requesterId value to EFS .Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.
Note
The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating , you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state.
We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS . In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target.
This operation requires permissions for the following action on the file system:
elasticfilesystem:CreateMountTargetThis operation also requires permissions for the following Amazon EC2 actions:
ec2:DescribeSubnetsec2:DescribeNetworkInterfacesec2:CreateNetworkInterfaceSee also: AWS API Documentation
Request Syntax
response = client.create_mount_target(
FileSystemId='string',
SubnetId='string',
IpAddress='string',
SecurityGroups=[
'string',
]
)
[REQUIRED]
The ID of the file system for which to create the mount target.
[REQUIRED]
The ID of the subnet to add the mount target in. For file systems that use One Zone storage classes, use the subnet that is associated with the file system's Availability Zone.
Up to five VPC security group IDs, of the form sg-xxxxxxxx . These must be for the same VPC as subnet specified.
dict
Response Syntax
{
'OwnerId': 'string',
'MountTargetId': 'string',
'FileSystemId': 'string',
'SubnetId': 'string',
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
'IpAddress': 'string',
'NetworkInterfaceId': 'string',
'AvailabilityZoneId': 'string',
'AvailabilityZoneName': 'string',
'VpcId': 'string'
}
Response Structure
(dict) --
Provides a description of a mount target.
OwnerId (string) --
Amazon Web Services account ID that owns the resource.
MountTargetId (string) --
System-assigned mount target ID.
FileSystemId (string) --
The ID of the file system for which the mount target is intended.
SubnetId (string) --
The ID of the mount target's subnet.
LifeCycleState (string) --
Lifecycle state of the mount target.
IpAddress (string) --
Address at which the file system can be mounted by using the mount target.
NetworkInterfaceId (string) --
The ID of the network interface that Amazon EFS created when it created the mount target.
AvailabilityZoneId (string) --
The unique and consistent identifier of the Availability Zone that the mount target resides in. For example, use1-az1 is an AZ ID for the us-east-1 Region and it has the same location in every Amazon Web Services account.
AvailabilityZoneName (string) --
The name of the Availability Zone in which the mount target is located. Availability Zones are independently mapped to names for each Amazon Web Services account. For example, the Availability Zone us-east-1a for your Amazon Web Services account might not be the same location as us-east-1a for another Amazon Web Services account.
VpcId (string) --
The virtual private cloud (VPC) ID that the mount target is configured in.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.IncorrectFileSystemLifeCycleStateEFS.Client.exceptions.MountTargetConflictEFS.Client.exceptions.SubnetNotFoundEFS.Client.exceptions.NoFreeAddressesInSubnetEFS.Client.exceptions.IpAddressInUseEFS.Client.exceptions.NetworkInterfaceLimitExceededEFS.Client.exceptions.SecurityGroupLimitExceededEFS.Client.exceptions.SecurityGroupNotFoundEFS.Client.exceptions.UnsupportedAvailabilityZoneEFS.Client.exceptions.AvailabilityZonesMismatchExamples
This operation creates a new mount target for an EFS file system.
response = client.create_mount_target(
FileSystemId='fs-01234567',
SubnetId='subnet-1234abcd',
)
print(response)
Expected Output:
{
'FileSystemId': 'fs-01234567',
'IpAddress': '192.0.0.2',
'LifeCycleState': 'creating',
'MountTargetId': 'fsmt-12340abc',
'NetworkInterfaceId': 'eni-cedf6789',
'OwnerId': '012345678912',
'SubnetId': 'subnet-1234abcd',
'ResponseMetadata': {
'...': '...',
},
}
create_replication_configuration(**kwargs)¶Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide . The replication configuration specifies the following:
Source file system - An existing EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration.
Destination file system configuration - The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration. The destination file system configuration consists of the following properties:
Note
After the file system is created, you cannot change the KMS key.
The following properties are set by default:
The following properties are turned off by default:
For more information, see Amazon EFS replication in the Amazon EFS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_replication_configuration(
SourceFileSystemId='string',
Destinations=[
{
'Region': 'string',
'AvailabilityZoneName': 'string',
'KmsKeyId': 'string'
},
]
)
[REQUIRED]
Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be a source or destination file system in another replication configuration.
[REQUIRED]
An array of destination configuration objects. Only one destination configuration object is supported.
Describes the destination file system to create in the replication configuration.
To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system.
To create a file system that uses EFS One Zone storage, specify the name of the Availability Zone in which to create the destination file system.
Specifies the Key Management Service (KMS) key that you want to use to encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS, /aws/elasticfilesystem . This ID can be in one of the following formats:
1234abcd-12ab-34cd-56ef-1234567890ab .arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .alias/projectKey1 .arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .dict
Response Syntax
{
'SourceFileSystemId': 'string',
'SourceFileSystemRegion': 'string',
'SourceFileSystemArn': 'string',
'OriginalSourceFileSystemArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'Destinations': [
{
'Status': 'ENABLED'|'ENABLING'|'DELETING'|'ERROR',
'FileSystemId': 'string',
'Region': 'string',
'LastReplicatedTimestamp': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
SourceFileSystemId (string) --
The ID of the source Amazon EFS file system that is being replicated.
SourceFileSystemRegion (string) --
The Amazon Web Services Region in which the source Amazon EFS file system is located.
SourceFileSystemArn (string) --
The Amazon Resource Name (ARN) of the current source file system in the replication configuration.
OriginalSourceFileSystemArn (string) --
The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.
CreationTime (datetime) --
Describes when the replication configuration was created.
Destinations (list) --
An array of destination objects. Only one destination object is supported.
(dict) --
Describes the destination file system in the replication configuration.
Status (string) --
Describes the status of the destination Amazon EFS file system. If the status is ERROR , the destination file system in the replication configuration is in a failed state and is unrecoverable. To access the file system data, restore a backup of the failed file system to a new file system.
FileSystemId (string) --
The ID of the destination Amazon EFS file system.
Region (string) --
The Amazon Web Services Region in which the destination file system is located.
LastReplicatedTimestamp (datetime) --
The time when the most recent sync was successfully completed on the destination file system. Any changes to data on the source file system that occurred before this time have been successfully replicated to the destination file system. Any changes that occurred after this time might not be fully replicated.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.IncorrectFileSystemLifeCycleStateEFS.Client.exceptions.ValidationExceptionEFS.Client.exceptions.ReplicationNotFoundEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.UnsupportedAvailabilityZoneEFS.Client.exceptions.FileSystemLimitExceededEFS.Client.exceptions.InsufficientThroughputCapacityEFS.Client.exceptions.ThroughputLimitExceededEFS.Client.exceptions.InternalServerErrorNote
DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS resources, use the API action.
Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.
This operation requires permission for the elasticfilesystem:CreateTags action.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.create_tags(
FileSystemId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.
[REQUIRED]
An array of Tag objects to add. Each Tag object is a key-value pair.
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
The tag key (String). The key can't start with aws: .
The value of the tag key.
None
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundExamples
This operation creates a new tag for an EFS file system.
response = client.create_tags(
FileSystemId='fs-01234567',
Tags=[
{
'Key': 'Name',
'Value': 'MyFileSystem',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_access_point(**kwargs)¶Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection.
This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.
See also: AWS API Documentation
Request Syntax
response = client.delete_access_point(
AccessPointId='string'
)
[REQUIRED]
The ID of the access point that you want to delete.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.AccessPointNotFounddelete_file_system(**kwargs)¶Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.
You need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system.
Note
You cannot delete a file system that is part of an EFS Replication configuration. You need to delete the replication configuration first.
You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget .
Note
The DeleteFileSystem call returns while the file system state is still deleting . You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.
This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.
See also: AWS API Documentation
Request Syntax
response = client.delete_file_system(
FileSystemId='string'
)
[REQUIRED]
The ID of the file system you want to delete.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.FileSystemInUseExamples
This operation deletes an EFS file system.
response = client.delete_file_system(
FileSystemId='fs-01234567',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_file_system_policy(**kwargs)¶Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS .
This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action.
See also: AWS API Documentation
Request Syntax
response = client.delete_file_system_policy(
FileSystemId='string'
)
[REQUIRED]
Specifies the EFS file system for which to delete the FileSystemPolicy .
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.IncorrectFileSystemLifeCycleStatedelete_mount_target(**kwargs)¶Deletes the specified mount target.
This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target.
This operation requires permissions for the following action on the file system:
elasticfilesystem:DeleteMountTargetNote
The DeleteMountTarget call returns while the mount target state is still deleting . You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.
The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:
ec2:DeleteNetworkInterfaceSee also: AWS API Documentation
Request Syntax
response = client.delete_mount_target(
MountTargetId='string'
)
[REQUIRED]
The ID of the mount target to delete (String).
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.DependencyTimeoutEFS.Client.exceptions.MountTargetNotFoundExamples
This operation deletes a mount target.
response = client.delete_mount_target(
MountTargetId='fsmt-12340abc',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_replication_configuration(**kwargs)¶Deletes an existing replication configuration. To delete a replication configuration, you must make the request from the Amazon Web Services Region in which the destination file system is located. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system is no longer read-only. You can write to the destination file system after its status becomes Writeable .
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_configuration(
SourceFileSystemId='string'
)
[REQUIRED]
The ID of the source file system in the replication configuration.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.ReplicationNotFoundNote
DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS resources, use the API action.
Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag restrictions in the Billing and Cost Management User Guide .
This operation requires permissions for the elasticfilesystem:DeleteTags action.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.delete_tags(
FileSystemId='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ID of the file system whose tags you want to delete (String).
[REQUIRED]
A list of tag keys to delete.
None
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundExamples
This operation deletes tags for an EFS file system.
response = client.delete_tags(
FileSystemId='fs-01234567',
TagKeys=[
'Name',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_access_points(**kwargs)¶Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId , it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both.
This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.
See also: AWS API Documentation
Request Syntax
response = client.describe_access_points(
MaxResults=123,
NextToken='string',
AccessPointId='string',
FileSystemId='string'
)
MaxItems parameter to limit the number of objects returned in a response. The default value is 100.NextToken is present if the response is paginated. You can use NextMarker in the subsequent request to fetch the next page of access point descriptions.FileSystemId .FileSystemId , EFS returns all access points for that file system; mutually exclusive with AccessPointId .dict
Response Syntax
{
'AccessPoints': [
{
'ClientToken': 'string',
'Name': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'AccessPointId': 'string',
'AccessPointArn': 'string',
'FileSystemId': 'string',
'PosixUser': {
'Uid': 123,
'Gid': 123,
'SecondaryGids': [
123,
]
},
'RootDirectory': {
'Path': 'string',
'CreationInfo': {
'OwnerUid': 123,
'OwnerGid': 123,
'Permissions': 'string'
}
},
'OwnerId': 'string',
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AccessPoints (list) --
An array of access point descriptions.
(dict) --
Provides a description of an EFS file system access point.
ClientToken (string) --
The opaque string specified in the request to ensure idempotent creation.
Name (string) --
The name of the access point. This is the value of the Name tag.
Tags (list) --
The tags associated with the access point, presented as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
AccessPointId (string) --
The ID of the access point, assigned by Amazon EFS.
AccessPointArn (string) --
The unique Amazon Resource Name (ARN) associated with the access point.
FileSystemId (string) --
The ID of the EFS file system that the access point applies to.
PosixUser (dict) --
The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
Uid (integer) --
The POSIX user ID used for all file system operations using this access point.
Gid (integer) --
The POSIX group ID used for all file system operations using this access point.
SecondaryGids (list) --
Secondary POSIX group IDs used for all file system operations using this access point.
RootDirectory (dict) --
The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
Path (string) --
Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo .
CreationInfo (dict) --
(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory . If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo , you must provide values for all properties.
Warning
If you do not provide CreationInfo and the specified RootDirectory > Path does not exist, attempts to mount the file system using the access point will fail.
OwnerUid (integer) --
Specifies the POSIX user ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).
OwnerGid (integer) --
Specifies the POSIX group ID to apply to the RootDirectory . Accepts values from 0 to 2^32 (4294967295).
Permissions (string) --
Specifies the POSIX permissions to apply to the RootDirectory , in the format of an octal number representing the file's mode bits.
OwnerId (string) --
Identified the Amazon Web Services account that owns the access point resource.
LifeCycleState (string) --
Identifies the lifecycle phase of the access point.
NextToken (string) --
Present if there are more access points than returned in the response. You can use the NextMarker in the subsequent request to fetch the additional descriptions.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.AccessPointNotFounddescribe_account_preferences(**kwargs)¶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. For more information, see Managing Amazon EFS resource IDs .
See also: AWS API Documentation
Request Syntax
response = client.describe_account_preferences(
NextToken='string',
MaxResults=123
)
NextToken in a subsequent request to fetch the next page of Amazon Web Services account preferences if the response payload was paginated.MaxItems parameter to limit the number of objects returned in a response. The default value is 100.dict
Response Syntax
{
'ResourceIdPreference': {
'ResourceIdType': 'LONG_ID'|'SHORT_ID',
'Resources': [
'FILE_SYSTEM'|'MOUNT_TARGET',
]
},
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceIdPreference (dict) --
Describes the resource ID preference setting for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
ResourceIdType (string) --
Identifies the EFS resource ID preference, either LONG_ID (17 characters) or SHORT_ID (8 characters).
Resources (list) --
Identifies the Amazon EFS resources to which the ID preference setting applies, FILE_SYSTEM and MOUNT_TARGET .
NextToken (string) --
Present if there are more records than returned in the response. You can use the NextToken in the subsequent request to fetch the additional descriptions.
Exceptions
EFS.Client.exceptions.InternalServerErrordescribe_backup_policy(**kwargs)¶Returns the backup policy for the specified EFS file system.
See also: AWS API Documentation
Request Syntax
response = client.describe_backup_policy(
FileSystemId='string'
)
[REQUIRED]
Specifies which EFS file system to retrieve the BackupPolicy for.
{
'BackupPolicy': {
'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
}
}
Response Structure
Describes the file system's backup policy, indicating whether automatic backups are turned on or off.
Describes the status of the file system's backup policy.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.PolicyNotFoundEFS.Client.exceptions.ValidationExceptiondescribe_file_system_policy(**kwargs)¶Returns the FileSystemPolicy for the specified EFS file system.
This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.
See also: AWS API Documentation
Request Syntax
response = client.describe_file_system_policy(
FileSystemId='string'
)
[REQUIRED]
Specifies which EFS file system to retrieve the FileSystemPolicy for.
{
'FileSystemId': 'string',
'Policy': 'string'
}
Response Structure
Specifies the EFS file system to which the FileSystemPolicy applies.
The JSON formatted FileSystemPolicy for the EFS file system.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.PolicyNotFounddescribe_file_systems(**kwargs)¶Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. Currently, this number is automatically set to 10. If more file system descriptions remain, Amazon EFS returns a NextMarker , an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker .
To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker .
The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.
This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.
See also: AWS API Documentation
Request Syntax
response = client.describe_file_systems(
MaxItems=123,
Marker='string',
CreationToken='string',
FileSystemId='string'
)
DescribeFileSystems operation (String). If present, specifies to continue the list from where the returning call had left off.dict
Response Syntax
{
'Marker': 'string',
'FileSystems': [
{
'OwnerId': 'string',
'CreationToken': 'string',
'FileSystemId': 'string',
'FileSystemArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
'Name': 'string',
'NumberOfMountTargets': 123,
'SizeInBytes': {
'Value': 123,
'Timestamp': datetime(2015, 1, 1),
'ValueInIA': 123,
'ValueInStandard': 123
},
'PerformanceMode': 'generalPurpose'|'maxIO',
'Encrypted': True|False,
'KmsKeyId': 'string',
'ThroughputMode': 'bursting'|'provisioned',
'ProvisionedThroughputInMibps': 123.0,
'AvailabilityZoneName': 'string',
'AvailabilityZoneId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Marker (string) --
Present if provided by caller in the request (String).
FileSystems (list) --
An array of file system descriptions.
(dict) --
A description of the file system.
OwnerId (string) --
The Amazon Web Services account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
CreationToken (string) --
The opaque string specified in the request.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
FileSystemArn (string) --
The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:*region* :*account-id* :file-system/*file-system-id* `` . Example with sample data: ``arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
CreationTime (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
LifeCycleState (string) --
The lifecycle phase of the file system.
Name (string) --
You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem . If the file system has a Name tag, Amazon EFS returns the value in this field.
NumberOfMountTargets (integer) --
The current number of mount targets that the file system has. For more information, see CreateMountTarget .
SizeInBytes (dict) --
The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.
Value (integer) --
The latest known metered size (in bytes) of data stored in the file system.
Timestamp (datetime) --
The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.
ValueInIA (integer) --
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
ValueInStandard (integer) --
The latest known metered size (in bytes) of data stored in the Standard storage class.
PerformanceMode (string) --
The performance mode of the file system.
Encrypted (boolean) --
A Boolean value that, if true, indicates that the file system is encrypted.
KmsKeyId (string) --
The ID of an KMS key used to protect the encrypted file system.
ThroughputMode (string) --
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide .
ProvisionedThroughputInMibps (float) --
The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned .
AvailabilityZoneName (string) --
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide .
AvailabilityZoneId (string) --
The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.
Tags (list) --
The tags associated with the file system, presented as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
NextMarker (string) --
Present if there are more file systems than returned in the response (String). You can use the NextMarker in the subsequent request to fetch the descriptions.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundExamples
This operation describes all of the EFS file systems in an account.
response = client.describe_file_systems(
)
print(response)
Expected Output:
{
'FileSystems': [
{
'CreationTime': datetime(2016, 12, 15, 22, 38, 44, 3, 350, 0),
'CreationToken': 'tokenstring',
'FileSystemId': 'fs-01234567',
'LifeCycleState': 'available',
'Name': 'MyFileSystem',
'NumberOfMountTargets': 1,
'OwnerId': '012345678912',
'PerformanceMode': 'generalPurpose',
'SizeInBytes': {
'Value': 6144,
},
'Tags': [
{
'Key': 'Name',
'Value': 'MyFileSystem',
},
],
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_lifecycle_configuration(**kwargs)¶Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.
When EFS Intelligent-Tiering is enabled, TransitionToPrimaryStorageClass has a value of AFTER_1_ACCESS .
This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_lifecycle_configuration(
FileSystemId='string'
)
[REQUIRED]
The ID of the file system whose LifecycleConfiguration object you want to retrieve (String).
{
'LifecyclePolicies': [
{
'TransitionToIA': 'AFTER_7_DAYS'|'AFTER_14_DAYS'|'AFTER_30_DAYS'|'AFTER_60_DAYS'|'AFTER_90_DAYS',
'TransitionToPrimaryStorageClass': 'AFTER_1_ACCESS'
},
]
}
Response Structure
An array of lifecycle management policies. EFS supports a maximum of one policy per file system.
Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle Management .
Note
When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToPrimaryStorageClass . For more information, see the request examples in PutLifecycleConfiguration .
Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.
Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.
Exceptions
EFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.BadRequestEFS.Client.exceptions.FileSystemNotFoundExamples
This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class.
response = client.describe_lifecycle_configuration(
FileSystemId='fs-01234567',
)
print(response)
Expected Output:
{
'LifecyclePolicies': [
{
'TransitionToIA': 'AFTER_30_DAYS',
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_mount_target_security_groups(**kwargs)¶Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted .
This operation requires permissions for the following actions:
elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system.ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.See also: AWS API Documentation
Request Syntax
response = client.describe_mount_target_security_groups(
MountTargetId='string'
)
[REQUIRED]
The ID of the mount target whose security groups you want to retrieve.
{
'SecurityGroups': [
'string',
]
}
Response Structure
An array of security groups.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.MountTargetNotFoundEFS.Client.exceptions.IncorrectMountTargetStateExamples
This operation describes all of the security groups for a file system's mount target.
response = client.describe_mount_target_security_groups(
MountTargetId='fsmt-12340abc',
)
print(response)
Expected Output:
{
'SecurityGroups': [
'sg-4567abcd',
],
'ResponseMetadata': {
'...': '...',
},
}
describe_mount_targets(**kwargs)¶Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.
This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId , or on the file system of the mount target that you specify in MountTargetId .
See also: AWS API Documentation
Request Syntax
response = client.describe_mount_targets(
MaxItems=123,
Marker='string',
FileSystemId='string',
MountTargetId='string',
AccessPointId='string'
)
DescribeMountTargets operation (String). If present, it specifies to continue the list from where the previous returning call left off.AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as input.FileSystemId is not included. Accepts either a mount target ID or ARN as input.FileSystemId or MountTargetId is not included in your request. Accepts either an access point ID or ARN as input.dict
Response Syntax
{
'Marker': 'string',
'MountTargets': [
{
'OwnerId': 'string',
'MountTargetId': 'string',
'FileSystemId': 'string',
'SubnetId': 'string',
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
'IpAddress': 'string',
'NetworkInterfaceId': 'string',
'AvailabilityZoneId': 'string',
'AvailabilityZoneName': 'string',
'VpcId': 'string'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Marker (string) --
If the request included the Marker , the response returns that value in this field.
MountTargets (list) --
Returns the file system's mount targets as an array of MountTargetDescription objects.
(dict) --
Provides a description of a mount target.
OwnerId (string) --
Amazon Web Services account ID that owns the resource.
MountTargetId (string) --
System-assigned mount target ID.
FileSystemId (string) --
The ID of the file system for which the mount target is intended.
SubnetId (string) --
The ID of the mount target's subnet.
LifeCycleState (string) --
Lifecycle state of the mount target.
IpAddress (string) --
Address at which the file system can be mounted by using the mount target.
NetworkInterfaceId (string) --
The ID of the network interface that Amazon EFS created when it created the mount target.
AvailabilityZoneId (string) --
The unique and consistent identifier of the Availability Zone that the mount target resides in. For example, use1-az1 is an AZ ID for the us-east-1 Region and it has the same location in every Amazon Web Services account.
AvailabilityZoneName (string) --
The name of the Availability Zone in which the mount target is located. Availability Zones are independently mapped to names for each Amazon Web Services account. For example, the Availability Zone us-east-1a for your Amazon Web Services account might not be the same location as us-east-1a for another Amazon Web Services account.
VpcId (string) --
The virtual private cloud (VPC) ID that the mount target is configured in.
NextMarker (string) --
If a value is present, there are more mount targets to return. In a subsequent request, you can provide Marker in your request with this value to retrieve the next set of mount targets.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.MountTargetNotFoundEFS.Client.exceptions.AccessPointNotFoundExamples
This operation describes all of a file system's mount targets.
response = client.describe_mount_targets(
FileSystemId='fs-01234567',
)
print(response)
Expected Output:
{
'MountTargets': [
{
'FileSystemId': 'fs-01234567',
'IpAddress': '192.0.0.2',
'LifeCycleState': 'available',
'MountTargetId': 'fsmt-12340abc',
'NetworkInterfaceId': 'eni-cedf6789',
'OwnerId': '012345678912',
'SubnetId': 'subnet-1234abcd',
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_replication_configurations(**kwargs)¶Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_configurations(
FileSystemId='string',
NextToken='string',
MaxResults=123
)
NextToken is present if the response is paginated. You can use NextToken in a subsequent request to fetch the next page of output.MaxItems parameter. The default value is 100.dict
Response Syntax
{
'Replications': [
{
'SourceFileSystemId': 'string',
'SourceFileSystemRegion': 'string',
'SourceFileSystemArn': 'string',
'OriginalSourceFileSystemArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'Destinations': [
{
'Status': 'ENABLED'|'ENABLING'|'DELETING'|'ERROR',
'FileSystemId': 'string',
'Region': 'string',
'LastReplicatedTimestamp': datetime(2015, 1, 1)
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Replications (list) --
The collection of replication configurations that is returned.
(dict) --
SourceFileSystemId (string) --
The ID of the source Amazon EFS file system that is being replicated.
SourceFileSystemRegion (string) --
The Amazon Web Services Region in which the source Amazon EFS file system is located.
SourceFileSystemArn (string) --
The Amazon Resource Name (ARN) of the current source file system in the replication configuration.
OriginalSourceFileSystemArn (string) --
The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.
CreationTime (datetime) --
Describes when the replication configuration was created.
Destinations (list) --
An array of destination objects. Only one destination object is supported.
(dict) --
Describes the destination file system in the replication configuration.
Status (string) --
Describes the status of the destination Amazon EFS file system. If the status is ERROR , the destination file system in the replication configuration is in a failed state and is unrecoverable. To access the file system data, restore a backup of the failed file system to a new file system.
FileSystemId (string) --
The ID of the destination Amazon EFS file system.
Region (string) --
The Amazon Web Services Region in which the destination file system is located.
LastReplicatedTimestamp (datetime) --
The time when the most recent sync was successfully completed on the destination file system. Any changes to data on the source file system that occurred before this time have been successfully replicated to the destination file system. Any changes that occurred after this time might not be fully replicated.
NextToken (string) --
You can use the NextToken from the previous response in a subsequent request to fetch the additional descriptions.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.ReplicationNotFoundEFS.Client.exceptions.ValidationExceptionNote
DEPRECATED - The DescribeTags action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource API action.
Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.
This operation requires permissions for the elasticfilesystem:DescribeTags action.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.describe_tags(
MaxItems=123,
Marker='string',
FileSystemId='string'
)
DescribeTags operation (String). If present, it specifies to continue the list from where the previous call left off.[REQUIRED]
The ID of the file system whose tag set you want to retrieve.
dict
Response Syntax
{
'Marker': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
Marker (string) --
If the request included a Marker , the response returns that value in this field.
Tags (list) --
Returns tags associated with the file system as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
NextMarker (string) --
If a value is present, there are more tags to return. In a subsequent request, you can provide the value of NextMarker as the value of the Marker parameter in your next request to retrieve the next set of tags.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundExamples
This operation describes all of a file system's tags.
response = client.describe_tags(
FileSystemId='fs-01234567',
)
print(response)
Expected Output:
{
'Tags': [
{
'Key': 'Name',
'Value': 'MyFileSystem',
},
],
'ResponseMetadata': {
'...': '...',
},
}
get_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.
This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access points using this API endpoint.
NextToken in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tags (list) --
An array of the tags for the specified EFS resource.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
NextToken (string) --
NextTokenis present if the response payload is paginated. You can useNextTokenin a subsequent request to fetch the next page of access point descriptions.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.AccessPointNotFoundmodify_mount_target_security_groups(**kwargs)¶Modifies the set of security groups in effect for a mount target.
When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget . This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted .
The operation requires permissions for the following actions:
elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system.ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.See also: AWS API Documentation
Request Syntax
response = client.modify_mount_target_security_groups(
MountTargetId='string',
SecurityGroups=[
'string',
]
)
[REQUIRED]
The ID of the mount target whose security groups you want to modify.
An array of up to five VPC security group IDs.
None
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.MountTargetNotFoundEFS.Client.exceptions.IncorrectMountTargetStateEFS.Client.exceptions.SecurityGroupLimitExceededEFS.Client.exceptions.SecurityGroupNotFoundExamples
This operation modifies the security groups associated with a mount target for a file system.
response = client.modify_mount_target_security_groups(
MountTargetId='fsmt-12340abc',
SecurityGroups=[
'sg-abcd1234',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
put_account_preferences(**kwargs)¶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. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs .
Note
Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.
See also: AWS API Documentation
Request Syntax
response = client.put_account_preferences(
ResourceIdType='LONG_ID'|'SHORT_ID'
)
[REQUIRED]
Specifies the EFS resource ID preference to set for the user's Amazon Web Services account, in the current Amazon Web Services Region, either LONG_ID (17 characters), or SHORT_ID (8 characters).
Note
Starting in October, 2021, you will receive an error when setting the account preference to SHORT_ID . Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.
{
'ResourceIdPreference': {
'ResourceIdType': 'LONG_ID'|'SHORT_ID',
'Resources': [
'FILE_SYSTEM'|'MOUNT_TARGET',
]
}
}
Response Structure
Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.
Identifies the EFS resource ID preference, either LONG_ID (17 characters) or SHORT_ID (8 characters).
Identifies the Amazon EFS resources to which the ID preference setting applies, FILE_SYSTEM and MOUNT_TARGET .
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorput_backup_policy(**kwargs)¶Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.
See also: AWS API Documentation
Request Syntax
response = client.put_backup_policy(
FileSystemId='string',
BackupPolicy={
'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
}
)
[REQUIRED]
Specifies which EFS file system to update the backup policy for.
[REQUIRED]
The backup policy included in the PutBackupPolicy request.
Describes the status of the file system's backup policy.
dict
Response Syntax
{
'BackupPolicy': {
'Status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
}
}
Response Structure
(dict) --
BackupPolicy (dict) --
Describes the file system's backup policy, indicating whether automatic backups are turned on or off.
Status (string) --
Describes the status of the file system's backup policy.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.IncorrectFileSystemLifeCycleStateEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.ValidationExceptionput_file_system_policy(**kwargs)¶Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS File System Policy .
Note
EFS file system policies have a 20,000 character limit.
This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.
See also: AWS API Documentation
Request Syntax
response = client.put_file_system_policy(
FileSystemId='string',
Policy='string',
BypassPolicyLockoutSafetyCheck=True|False
)
[REQUIRED]
The ID of the EFS file system that you want to create or update the FileSystemPolicy for.
[REQUIRED]
The FileSystemPolicy that you're creating. Accepts a JSON formatted policy definition. EFS file system policies have a 20,000 character limit. To find out more about the elements that make up a file system policy, see EFS Resource-based Policies .
FileSystemPolicy lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False .dict
Response Syntax
{
'FileSystemId': 'string',
'Policy': 'string'
}
Response Structure
(dict) --
FileSystemId (string) --
Specifies the EFS file system to which the FileSystemPolicy applies.
Policy (string) --
The JSON formatted FileSystemPolicy for the EFS file system.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.InvalidPolicyExceptionEFS.Client.exceptions.IncorrectFileSystemLifeCycleStateput_lifecycle_configuration(**kwargs)¶Use this action to manage EFS lifecycle management and intelligent tiering. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following:
TransitionToIA to one of the available options.TransitionToPrimaryStorageClass to AFTER_1_ACCESS .For more information, see EFS Lifecycle Management .
Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and turns off lifecycle management and intelligent tiering for the file system.
In the request, specify the following:
LifecyclePolicies array of LifecyclePolicy objects that define when files are moved into IA storage, and when they are moved back to Standard storage.Note
Amazon EFS requires that each LifecyclePolicy object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See the example requests in the following section for more information.
This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.
To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.
See also: AWS API Documentation
Request Syntax
response = client.put_lifecycle_configuration(
FileSystemId='string',
LifecyclePolicies=[
{
'TransitionToIA': 'AFTER_7_DAYS'|'AFTER_14_DAYS'|'AFTER_30_DAYS'|'AFTER_60_DAYS'|'AFTER_90_DAYS',
'TransitionToPrimaryStorageClass': 'AFTER_1_ACCESS'
},
]
)
[REQUIRED]
The ID of the file system for which you are creating the LifecycleConfiguration object (String).
[REQUIRED]
An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS lifecycle management and EFS Intelligent-Tiering of the following:
Note
When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToPrimaryStorageClass . See the example requests in the following section for more information.
Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle Management .
Note
When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToPrimaryStorageClass . For more information, see the request examples in PutLifecycleConfiguration .
Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.
Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.
dict
Response Syntax
{
'LifecyclePolicies': [
{
'TransitionToIA': 'AFTER_7_DAYS'|'AFTER_14_DAYS'|'AFTER_30_DAYS'|'AFTER_60_DAYS'|'AFTER_90_DAYS',
'TransitionToPrimaryStorageClass': 'AFTER_1_ACCESS'
},
]
}
Response Structure
(dict) --
LifecyclePolicies (list) --
An array of lifecycle management policies. EFS supports a maximum of one policy per file system.
(dict) --
Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle Management .
Note
When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToPrimaryStorageClass . For more information, see the request examples in PutLifecycleConfiguration .
TransitionToIA (string) --
Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.
TransitionToPrimaryStorageClass (string) --
Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.IncorrectFileSystemLifeCycleStateExamples
This operation enables lifecycle management on a file system by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.
response = client.put_lifecycle_configuration(
FileSystemId='fs-01234567',
LifecyclePolicies=[
{
'TransitionToIA': 'AFTER_30_DAYS',
},
],
)
print(response)
Expected Output:
{
'LifecyclePolicies': [
{
'TransitionToIA': 'AFTER_30_DAYS',
},
],
'ResponseMetadata': {
'...': '...',
},
}
tag_resource(**kwargs)¶Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.
This operation requires permissions for the elasticfilesystem:TagResource action.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID specifying the EFS resource that you want to create a tag for.
[REQUIRED]
An array of Tag objects to add. Each Tag object is a key-value pair.
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
The tag key (String). The key can't start with aws: .
The value of the tag key.
None
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.AccessPointNotFounduntag_resource(**kwargs)¶Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.
This operation requires permissions for the elasticfilesystem:UntagResource action.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceId='string',
TagKeys=[
'string',
]
)
[REQUIRED]
Specifies the EFS resource that you want to remove tags from.
[REQUIRED]
The keys of the key-value tag pairs that you want to remove from the specified EFS resource.
None
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.AccessPointNotFoundupdate_file_system(**kwargs)¶Updates the throughput mode or the amount of provisioned throughput of an existing file system.
See also: AWS API Documentation
Request Syntax
response = client.update_file_system(
FileSystemId='string',
ThroughputMode='bursting'|'provisioned',
ProvisionedThroughputInMibps=123.0
)
[REQUIRED]
The ID of the file system that you want to update.
ThroughputMode to provisioned , you must also set a value for ProvisionedThroughputInMibps .ThroughputMode is changed to provisioned on update.dict
Response Syntax
{
'OwnerId': 'string',
'CreationToken': 'string',
'FileSystemId': 'string',
'FileSystemArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
'Name': 'string',
'NumberOfMountTargets': 123,
'SizeInBytes': {
'Value': 123,
'Timestamp': datetime(2015, 1, 1),
'ValueInIA': 123,
'ValueInStandard': 123
},
'PerformanceMode': 'generalPurpose'|'maxIO',
'Encrypted': True|False,
'KmsKeyId': 'string',
'ThroughputMode': 'bursting'|'provisioned',
'ProvisionedThroughputInMibps': 123.0,
'AvailabilityZoneName': 'string',
'AvailabilityZoneId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
A description of the file system.
OwnerId (string) --
The Amazon Web Services account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
CreationToken (string) --
The opaque string specified in the request.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
FileSystemArn (string) --
The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:*region* :*account-id* :file-system/*file-system-id* `` . Example with sample data: ``arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
CreationTime (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
LifeCycleState (string) --
The lifecycle phase of the file system.
Name (string) --
You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem . If the file system has a Name tag, Amazon EFS returns the value in this field.
NumberOfMountTargets (integer) --
The current number of mount targets that the file system has. For more information, see CreateMountTarget .
SizeInBytes (dict) --
The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.
Value (integer) --
The latest known metered size (in bytes) of data stored in the file system.
Timestamp (datetime) --
The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.
ValueInIA (integer) --
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
ValueInStandard (integer) --
The latest known metered size (in bytes) of data stored in the Standard storage class.
PerformanceMode (string) --
The performance mode of the file system.
Encrypted (boolean) --
A Boolean value that, if true, indicates that the file system is encrypted.
KmsKeyId (string) --
The ID of an KMS key used to protect the encrypted file system.
ThroughputMode (string) --
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide .
ProvisionedThroughputInMibps (float) --
The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned .
AvailabilityZoneName (string) --
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide .
AvailabilityZoneId (string) --
The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.
Tags (list) --
The tags associated with the file system, presented as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
Exceptions
EFS.Client.exceptions.BadRequestEFS.Client.exceptions.FileSystemNotFoundEFS.Client.exceptions.IncorrectFileSystemLifeCycleStateEFS.Client.exceptions.InsufficientThroughputCapacityEFS.Client.exceptions.InternalServerErrorEFS.Client.exceptions.ThroughputLimitExceededEFS.Client.exceptions.TooManyRequestsThe available paginators are:
EFS.Paginator.DescribeFileSystems¶paginator = client.get_paginator('describe_file_systems')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from EFS.Client.describe_file_systems().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CreationToken='string',
FileSystemId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Marker': 'string',
'FileSystems': [
{
'OwnerId': 'string',
'CreationToken': 'string',
'FileSystemId': 'string',
'FileSystemArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
'Name': 'string',
'NumberOfMountTargets': 123,
'SizeInBytes': {
'Value': 123,
'Timestamp': datetime(2015, 1, 1),
'ValueInIA': 123,
'ValueInStandard': 123
},
'PerformanceMode': 'generalPurpose'|'maxIO',
'Encrypted': True|False,
'KmsKeyId': 'string',
'ThroughputMode': 'bursting'|'provisioned',
'ProvisionedThroughputInMibps': 123.0,
'AvailabilityZoneName': 'string',
'AvailabilityZoneId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Marker (string) --
Present if provided by caller in the request (String).
FileSystems (list) --
An array of file system descriptions.
(dict) --
A description of the file system.
OwnerId (string) --
The Amazon Web Services account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
CreationToken (string) --
The opaque string specified in the request.
FileSystemId (string) --
The ID of the file system, assigned by Amazon EFS.
FileSystemArn (string) --
The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:*region* :*account-id* :file-system/*file-system-id* `` . Example with sample data: ``arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
CreationTime (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
LifeCycleState (string) --
The lifecycle phase of the file system.
Name (string) --
You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem . If the file system has a Name tag, Amazon EFS returns the value in this field.
NumberOfMountTargets (integer) --
The current number of mount targets that the file system has. For more information, see CreateMountTarget .
SizeInBytes (dict) --
The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.
Value (integer) --
The latest known metered size (in bytes) of data stored in the file system.
Timestamp (datetime) --
The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.
ValueInIA (integer) --
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
ValueInStandard (integer) --
The latest known metered size (in bytes) of data stored in the Standard storage class.
PerformanceMode (string) --
The performance mode of the file system.
Encrypted (boolean) --
A Boolean value that, if true, indicates that the file system is encrypted.
KmsKeyId (string) --
The ID of an KMS key used to protect the encrypted file system.
ThroughputMode (string) --
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide .
ProvisionedThroughputInMibps (float) --
The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned .
AvailabilityZoneName (string) --
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide .
AvailabilityZoneId (string) --
The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.
Tags (list) --
The tags associated with the file system, presented as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
NextToken (string) --
A token to resume pagination.
EFS.Paginator.DescribeMountTargets¶paginator = client.get_paginator('describe_mount_targets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from EFS.Client.describe_mount_targets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FileSystemId='string',
MountTargetId='string',
AccessPointId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as input.FileSystemId is not included. Accepts either a mount target ID or ARN as input.FileSystemId or MountTargetId is not included in your request. Accepts either an access point ID or ARN as input.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Marker': 'string',
'MountTargets': [
{
'OwnerId': 'string',
'MountTargetId': 'string',
'FileSystemId': 'string',
'SubnetId': 'string',
'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
'IpAddress': 'string',
'NetworkInterfaceId': 'string',
'AvailabilityZoneId': 'string',
'AvailabilityZoneName': 'string',
'VpcId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Marker (string) --
If the request included the Marker , the response returns that value in this field.
MountTargets (list) --
Returns the file system's mount targets as an array of MountTargetDescription objects.
(dict) --
Provides a description of a mount target.
OwnerId (string) --
Amazon Web Services account ID that owns the resource.
MountTargetId (string) --
System-assigned mount target ID.
FileSystemId (string) --
The ID of the file system for which the mount target is intended.
SubnetId (string) --
The ID of the mount target's subnet.
LifeCycleState (string) --
Lifecycle state of the mount target.
IpAddress (string) --
Address at which the file system can be mounted by using the mount target.
NetworkInterfaceId (string) --
The ID of the network interface that Amazon EFS created when it created the mount target.
AvailabilityZoneId (string) --
The unique and consistent identifier of the Availability Zone that the mount target resides in. For example, use1-az1 is an AZ ID for the us-east-1 Region and it has the same location in every Amazon Web Services account.
AvailabilityZoneName (string) --
The name of the Availability Zone in which the mount target is located. Availability Zones are independently mapped to names for each Amazon Web Services account. For example, the Availability Zone us-east-1a for your Amazon Web Services account might not be the same location as us-east-1a for another Amazon Web Services account.
VpcId (string) --
The virtual private cloud (VPC) ID that the mount target is configured in.
NextToken (string) --
A token to resume pagination.
EFS.Paginator.DescribeTags¶paginator = client.get_paginator('describe_tags')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from EFS.Client.describe_tags().
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FileSystemId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the file system whose tag set you want to retrieve.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Marker': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Marker (string) --
If the request included a Marker , the response returns that value in this field.
Tags (list) --
Returns tags associated with the file system as an array of Tag objects.
(dict) --
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:+ - = . _ : / .
Key (string) --
The tag key (String). The key can't start with aws: .
Value (string) --
The value of the tag key.
NextToken (string) --
A token to resume pagination.