Amazon Elastic File System
Amazon Elastic File System Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Elastic File System
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 .
Endpoints 31
- GETDescribe access points
/2015-02-01/access-points?MaxResults=0&NextToken=string&AccessPointId=string&FileSystemId=stringReturns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId , it returns descriptions… - POSTCreate access point
/2015-02-01/access-pointsCreates 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… - GETDescribe file systems
/2015-02-01/file-systems?MaxItems=0&Marker=string&CreationToken=string&FileSystemId=stringReturns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns… - POSTCreate file system
/2015-02-01/file-systemsCreates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the… - GETDescribe mount targets
/2015-02-01/mount-targets?MaxItems=0&Marker=string&FileSystemId=string&MountTargetId=string&AccessPointId=stringReturns 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,… - POSTCreate mount target
/2015-02-01/mount-targetsCreates 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… - POSTCreate replication configuration
/2015-02-01/file-systems/:SourceFileSystemId/replication-configurationCreates a replication configuration to either a new or existing EFS file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide… - DELETEDelete replication configuration
/2015-02-01/file-systems/:SourceFileSystemId/replication-configuration?deletionMode=stringDeletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the… - POSTCreate tags
/2015-02-01/create-tags/:FileSystemIdDeprecated. DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS resources, use the API action. Creates or overwrites tags… - DELETEDelete access point
/2015-02-01/access-points/:AccessPointIdDeletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point… - PUTUpdate file system
/2015-02-01/file-systems/:FileSystemIdUpdates the throughput mode or the amount of provisioned throughput of an existing file system. - DELETEDelete file system
/2015-02-01/file-systems/:FileSystemIdDeletes 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… - GETDescribe file system policy
/2015-02-01/file-systems/:FileSystemId/policyReturns the FileSystemPolicy for the specified EFS file system. This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action. - PUTPut file system policy
/2015-02-01/file-systems/:FileSystemId/policyApplies 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… - DELETEDelete file system policy
/2015-02-01/file-systems/:FileSystemId/policyDeletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect once the existing policy is deleted. For more… - DELETEDelete mount target
/2015-02-01/mount-targets/:MountTargetIdDeletes 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… - POSTDelete tags
/2015-02-01/delete-tags/:FileSystemIdDeprecated. DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS resources, use the API action. Deletes the specified tags from a… - GETDescribe account preferences
/2015-02-01/account-preferencesReturns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services… - PUTPut account preferences
/2015-02-01/account-preferencesUse 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)… - GETDescribe backup policy
/2015-02-01/file-systems/:FileSystemId/backup-policyReturns the backup policy for the specified EFS file system. - PUTPut backup policy
/2015-02-01/file-systems/:FileSystemId/backup-policyUpdates the file system's backup policy. Use this action to start or stop automatic backups of the file system. - GETDescribe lifecycle configuration
/2015-02-01/file-systems/:FileSystemId/lifecycle-configurationReturns the current LifecycleConfiguration object for the specified EFS file system. Lifecycle management uses the LifecycleConfiguration object to identify… - PUTPut lifecycle configuration
/2015-02-01/file-systems/:FileSystemId/lifecycle-configurationUse this action to manage storage for your file system. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following:… - GETDescribe mount target security groups
/2015-02-01/mount-targets/:MountTargetId/security-groupsReturns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created… - PUTModify mount target security groups
/2015-02-01/mount-targets/:MountTargetId/security-groupsModifies 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… - GETDescribe replication configurations
/2015-02-01/file-systems/replication-configurations?FileSystemId=string&NextToken=string&MaxResults=0Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon… - GETDescribe tags
/2015-02-01/tags/:FileSystemId?MaxItems=0&Marker=stringDeprecated. DEPRECATED - The DescribeTags action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource API… - GETList tags for resource
/2015-02-01/resource-tags/:ResourceId?MaxResults=0&NextToken=stringLists 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… - POSTTag resource
/2015-02-01/resource-tags/:ResourceIdCreates 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… - DELETEUntag resource
/2015-02-01/resource-tags/:ResourceId?tagKeys=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… - PUTUpdate file system protection
/2015-02-01/file-systems/:FileSystemId/protectionUpdates protection on the file system. This operation requires permissions for the elasticfilesystem:UpdateFileSystemProtection action.
API details
- Base URL
https://elasticfilesystem.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 31 operations on 18 pathsGET 11PUT 7POST 7DELETE 6
3 marked deprecated - Description format
- AWS Smithy model, API version
2015-02-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Elastic File System in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Elastic File System collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Describe access points” (GET /2015-02-01/access-points?MaxResults=0&NextToken=string&AccessPointId=string&FileSystemId=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Elastic File System?
Amazon Elastic File System Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in… It is listed under Developer tools and has 31 endpoints.
Who publishes the Amazon Elastic File System?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Elastic File System?
Requests go to https://elasticfilesystem.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Elastic File System?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Elastic File System have?
31 operations on 18 paths (11 GET, 7 PUT, 7 POST, 6 DELETE).
Is forking the Amazon Elastic File System free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.