2015/06/22 - Amazon Elastic File System - 11 new api methods
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 API.
This operation requires permission for the elasticfilesystem:CreateTags action.
Request Syntax
client.create_tags( FileSystemId='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] )
string
[REQUIRED]
String. The ID of the file system whose tags you want to modify. This operation modifies only the tags and not the file system.
list
[REQUIRED]
An array of Tag objects to add. Each Tag object is a key-value pair.
(dict) --
A tag is a pair of key and value. The allowed characters in keys and values are letters, whitespace, and numbers, representable in UTF-8, and the characters '+', '-', '=', '.', '_', ':', and '/'.
Key (string) -- [REQUIRED]
Tag key, a string. The key must not start with "aws:".
Value (string) -- [REQUIRED]
Value of the tag key.
None
Returns the descriptions of the current mount targets for a file system. The order of mount targets returned in the response is unspecified.
This operation requires permission for the elasticfilesystem:DescribeMountTargets action on the file system FileSystemId.
Request Syntax
client.describe_mount_targets( MaxItems=123, Marker='string', FileSystemId='string' )
integer
Optional. Maximum number of mount targets to return in the response. It must be an integer with a value greater than zero.
string
Optional. String. Opaque pagination token returned from a previous DescribeMountTargets operation. If present, it specifies to continue the list from where the previous returning call left off.
string
[REQUIRED]
String. The ID of the file system whose mount targets you want to list.
dict
Response Syntax
{ 'Marker': 'string', 'MountTargets': [ { 'OwnerId': 'string', 'MountTargetId': 'string', 'FileSystemId': 'string', 'SubnetId': 'string', 'LifeCycleState': 'creating'|'available'|'deleting'|'deleted', 'IpAddress': 'string', 'NetworkInterfaceId': '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) --
This object provides description of a mount target.
OwnerId (string) --
The AWS account ID that owns the resource.
MountTargetId (string) --
The 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 subnet that the mount target is in.
LifeCycleState (string) --
The lifecycle state the mount target is in.
IpAddress (string) --
The address at which the file system may be mounted via the mount target.
NetworkInterfaceId (string) --
The ID of the network interface that Amazon EFS created when it created the mount target.
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.
Creates a mount target for a file system. You can then mount the file system on EC2 instances via 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. For more information, see Amazon EFS: How it Works.
In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be "available" (see DescribeFileSystems).
In the request, you also provide a subnet ID, which serves several purposes:
It determines the VPC in which Amazon EFS creates the mount target.
It determines the Availability Zone in which Amazon EFS creates the mount target.
It determines the IP address range from which Amazon EFS selects the IP address of the mount target if you don't specify an IP address in the request.
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 via 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 request to add another mount target must meet the following requirements:
The subnet specified in the request must belong to the same VPC as the subnets of the existing mount targets.
The subnet specified in the request must not be in the same Availability Zone as any of the subnets of the existing mount targets.
If the request satisfies the requirements, Amazon EFS does the following:
Creates a new mount target in the specified subnet.
Also creates a new network interface in the subnet as follows:
If the request provides an 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).
If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.
Assigns the description "Mount target fsmt-id for file system fs-id" where fsmt-id is the mount target ID, and fs-id is the FileSystemId.
Sets the requesterManaged property of the network interface to "true", and the requesterId value to "EFS".
Each Amazon EFS mount target has one corresponding requestor-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.
We recommend 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, go to Amazon EFS product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availablity Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target.
This operation requires permission for the following action on the file system:
elasticfilesystem:CreateMountTarget
This operation also requires permission for the following Amazon EC2 actions:
ec2:DescribeSubnets
ec2:DescribeNetworkInterfaces
ec2:CreateNetworkInterface
Request Syntax
client.create_mount_target( FileSystemId='string', SubnetId='string', IpAddress='string', SecurityGroups=[ 'string', ] )
string
[REQUIRED]
The ID of the file system for which to create the mount target.
string
[REQUIRED]
The ID of the subnet to add the mount target in.
string
A valid IPv4 address within the address range of the specified subnet.
list
Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.
(string) --
dict
Response Syntax
{ 'OwnerId': 'string', 'MountTargetId': 'string', 'FileSystemId': 'string', 'SubnetId': 'string', 'LifeCycleState': 'creating'|'available'|'deleting'|'deleted', 'IpAddress': 'string', 'NetworkInterfaceId': 'string' }
Response Structure
(dict) --
This object provides description of a mount target.
OwnerId (string) --
The AWS account ID that owns the resource.
MountTargetId (string) --
The 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 subnet that the mount target is in.
LifeCycleState (string) --
The lifecycle state the mount target is in.
IpAddress (string) --
The address at which the file system may be mounted via the mount target.
NetworkInterfaceId (string) --
The ID of the network interface that Amazon EFS created when it created the mount target.
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 multi-call iteration (when using pagination), is unspecified.
This operation requires permission for the elasticfilesystem:DescribeTags action.
Request Syntax
client.describe_tags( MaxItems=123, Marker='string', FileSystemId='string' )
integer
Optional. Maximum number of file system tags to return in the response. It must be an integer with a value greater than zero.
string
Optional. String. Opaque pagination token returned from a previous DescribeTags operation. If present, it specifies to continue the list from where the previous call left off.
string
[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 pair of key and value. The allowed characters in keys and values are letters, whitespace, and numbers, representable in UTF-8, and the characters '+', '-', '=', '.', '_', ':', and '/'.
Key (string) --
Tag key, a string. The key must not start with "aws:".
Value (string) --
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.
Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided; otherwise, returns descriptions of all file systems owned by the caller's AWS account in the AWS 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. 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.
So to retrieve a list of your file system descriptions, the expected usage of this API is an iterative process of first calling DescribeFileSystems without the Marker and then continuing to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.
Note that the implementation may return fewer than MaxItems file system descriptions while still including a NextMarker value.
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 permission for the elasticfilesystem:DescribeFileSystems action.
Request Syntax
client.describe_file_systems( MaxItems=123, Marker='string', CreationToken='string', FileSystemId='string' )
integer
Optional integer. Specifies the maximum number of file systems to return in the response. This parameter value must be greater than 0. The number of items Amazon EFS returns will be the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.
string
Optional string. Opaque pagination token returned from a previous DescribeFileSystems operation. If present, specifies to continue the list from where the returning call had left off.
string
Optional string. Restricts the list to the file system with this creation token (you specify a creation token at the time of creating an Amazon EFS file system).
string
Optional string. File system ID whose description you want to retrieve.
dict
Response Syntax
{ 'Marker': 'string', 'FileSystems': [ { 'OwnerId': 'string', 'CreationToken': 'string', 'FileSystemId': 'string', 'CreationTime': datetime(2015, 1, 1), 'LifeCycleState': 'creating'|'available'|'deleting'|'deleted', 'Name': 'string', 'NumberOfMountTargets': 123, 'SizeInBytes': { 'Value': 123, 'Timestamp': datetime(2015, 1, 1) } }, ], 'NextMarker': 'string' }
Response Structure
(dict) --
Marker (string) --
A string, present if provided by caller in the request.
FileSystems (list) --
An array of file system descriptions.
(dict) --
This object provides description of a file system.
OwnerId (string) --
The AWS 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) --
Opaque string specified in the request.
FileSystemId (string) --
The file system ID assigned by Amazon EFS.
CreationTime (datetime) --
The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.
LifeCycleState (string) --
A predefined string value that indicates the lifecycle phase of the file system.
Name (string) --
You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.
NumberOfMountTargets (integer) --
The current number of mount targets (see CreateMountTarget) the file system has.
SizeInBytes (dict) --
This object provides the latest known metered size of data stored in the file system, in bytes, 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. Note that the value does not 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, the value will represent 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 the file system was at any instant 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.
NextMarker (string) --
A string, present if there are more file systems than returned in the response. You can use the NextMarker in the subsequent request to fetch the descriptions.
Deletes the specified mount target.
This operation forcibly breaks any mounts of the file system via the mount target 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 may 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 using another mount target.
This operation requires permission for the following action on the file system:
elasticfilesystem:DeleteMountTarget
The operation also requires permission for the following Amazon EC2 action on the mount target's network interface:
ec2:DeleteNetworkInterface
Request Syntax
client.delete_mount_target( MountTargetId='string' )
string
[REQUIRED]
String. The ID of the mount target to delete.
None
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 AWS account with the specified creation token, this operation does the following:
Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state "creating".
Returns with the description of the created file system.
Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.
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.
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 ( CreateMountTarget) in your VPC. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works
This operation requires permission for the elasticfilesystem:CreateFileSystem action.
Request Syntax
client.create_file_system( CreationToken='string' )
string
[REQUIRED]
String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
dict
Response Syntax
{ 'OwnerId': 'string', 'CreationToken': 'string', 'FileSystemId': 'string', 'CreationTime': datetime(2015, 1, 1), 'LifeCycleState': 'creating'|'available'|'deleting'|'deleted', 'Name': 'string', 'NumberOfMountTargets': 123, 'SizeInBytes': { 'Value': 123, 'Timestamp': datetime(2015, 1, 1) } }
Response Structure
(dict) --
This object provides description of a file system.
OwnerId (string) --
The AWS 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) --
Opaque string specified in the request.
FileSystemId (string) --
The file system ID assigned by Amazon EFS.
CreationTime (datetime) --
The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.
LifeCycleState (string) --
A predefined string value that indicates the lifecycle phase of the file system.
Name (string) --
You can add tags to a file system (see CreateTags) including a "Name" tag. If the file system has a "Name" tag, Amazon EFS returns the value in this field.
NumberOfMountTargets (integer) --
The current number of mount targets (see CreateMountTarget) the file system has.
SizeInBytes (dict) --
This object provides the latest known metered size of data stored in the file system, in bytes, 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. Note that the value does not 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, the value will represent 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 the file system was at any instant 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.
Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system.
You cannot 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.
This operation requires permission for the elasticfilesystem:DeleteFileSystem action.
Request Syntax
client.delete_file_system( FileSystemId='string' )
string
[REQUIRED]
The ID of the file system you want to delete.
None
Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that does not exist, Amazon EFS ignores it; it is not an error. For more information about tags and related restrictions, go to Tag Restrictions in the AWS Billing and Cost Management User Guide.
This operation requires permission for the elasticfilesystem:DeleteTags action.
Request Syntax
client.delete_tags( FileSystemId='string', TagKeys=[ 'string', ] )
string
[REQUIRED]
String. The ID of the file system whose tags you want to delete.
list
[REQUIRED]
A list of tag keys to delete.
(string) --
None
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 (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 life cycle 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.
Request Syntax
client.modify_mount_target_security_groups( MountTargetId='string', SecurityGroups=[ 'string', ] )
string
[REQUIRED]
The ID of the mount target whose security groups you want to modify.
list
An array of up to five VPC security group IDs.
(string) --
None
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 life cycle 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.
Request Syntax
client.describe_mount_target_security_groups( MountTargetId='string' )
string
[REQUIRED]
The ID of the mount target whose security groups you want to retrieve.
dict
Response Syntax
{ 'SecurityGroups': [ 'string', ] }
Response Structure
(dict) --
SecurityGroups (list) --
An array of security groups.
(string) --