AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessPointAlreadyExistsException

Returned if the access point that you are trying to create already exists, with the creation token you provided in the request.

Class AccessPointDescription

Provides a description of an EFS file system access point.

Class AccessPointLimitExceededException

Returned if the Amazon Web Services account has already created the maximum number of access points allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region.

Class AccessPointNotFoundException

Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web Services account.

Class AvailabilityZonesMismatchException

Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone storage redundancy.

Class BackupPolicy

The backup policy for the file system used to create automatic daily backups. If status has a value of ENABLED, the file system is being automatically backed up. For more information, see Automatic backups.

Class BadRequestException

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

Class ConflictException

Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.

Class CreateAccessPointRequest

Container for the parameters to the CreateAccessPoint operation. 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.

If multiple requests to create access points on the same file system are sent in quick succession, and the file system is near the limit of 1,000 access points, you may experience a throttling response for these requests. This is to ensure that the file system does not exceed the stated access point limit.

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.

Class CreateAccessPointResponse

Provides a description of an EFS file system access point.

Class CreateFileSystemRequest

Container for the parameters to the CreateFileSystem operation. 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:

  • 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.

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.

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 generalPurposePerformanceMode for all file systems. The maxIO mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than the generalPurpose mode. MaxIO mode is not supported for One Zone file systems or file systems that use Elastic throughput.

The PerformanceMode 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.

File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource action. For more information, see Granting permissions to tag resources during creation.

Class CreateFileSystemResponse

A description of the file system.

Class CreateMountTargetRequest

Container for the parameters to the CreateMountTarget operation. 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 a One Zone file system. 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:

  • The file system ID for which you are creating the mount target.

  • A subnet ID, which determines the following:

    • The VPC in which Amazon EFS creates the mount target

    • The Availability Zone in which Amazon EFS creates the mount target

    • 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 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:

  • Must belong to the same VPC as the subnets of the existing mount targets

  • 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 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.

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:CreateMountTarget

This operation also requires permissions for the following Amazon EC2 actions:

  • ec2:DescribeSubnets

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

Class CreateMountTargetResponse

Provides a description of a mount target.

Class CreateReplicationConfigurationRequest

Container for the parameters to the CreateReplicationConfiguration operation. Creates 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. The replication configuration specifies the following:

  • Source file system – The EFS file system that you want to replicate.

  • Destination file system – The destination file system to which the source file system is replicated. There can only be one destination file system in a replication configuration.

    A file system can be part of only one replication configuration.

    The destination parameters for the replication configuration depend on whether you are replicating to a new file system or to an existing file system, and if you are replicating across Amazon Web Services accounts. See DestinationToCreate for more information.

This operation requires permissions for the elasticfilesystem:CreateReplicationConfiguration action. Additionally, other permissions are required depending on how you are replicating file systems. For more information, see Required permissions for replication in the Amazon EFS User Guide.

Class CreateReplicationConfigurationResponse

Describes the replication configuration for a specific file system.

Class CreateTagsRequest

Container for the parameters to the CreateTags operation.

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.

Class CreateTagsResponse

This is the response object from the CreateTags operation.

Class CreationInfo

Required if the RootDirectory > Path specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory > Path. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying CreationInfo, you must include values for all properties.

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.

If you do not provide CreationInfo and the specified RootDirectory does not exist, attempts to mount the file system using the access point will fail.

Class DeleteAccessPointRequest

Container for the parameters to the DeleteAccessPoint operation. 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.

Class DeleteAccessPointResponse

This is the response object from the DeleteAccessPoint operation.

Class DeleteFileSystemPolicyRequest

Container for the parameters to the DeleteFileSystemPolicy operation. 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.

Class DeleteFileSystemPolicyResponse

This is the response object from the DeleteFileSystemPolicy operation.

Class DeleteFileSystemRequest

Container for the parameters to the DeleteFileSystem operation. 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.

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.

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.

Class DeleteFileSystemResponse

This is the response object from the DeleteFileSystem operation.

Class DeleteMountTargetRequest

Container for the parameters to the DeleteMountTarget operation. 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:DeleteMountTarget

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:DeleteNetworkInterface

Class DeleteMountTargetResponse

This is the response object from the DeleteMountTarget operation.

Class DeleteReplicationConfigurationRequest

Container for the parameters to the DeleteReplicationConfiguration operation. Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes Writeable and its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration.

This operation requires permissions for the elasticfilesystem:DeleteReplicationConfiguration action.

Class DeleteReplicationConfigurationResponse

This is the response object from the DeleteReplicationConfiguration operation.

Class DeleteTagsRequest

Container for the parameters to the DeleteTags operation.

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.

Class DeleteTagsResponse

This is the response object from the DeleteTags operation.

Class DependencyTimeoutException

The service timed out trying to fulfill the request, and the client should try the call again.

Class DescribeAccessPointsRequest

Container for the parameters to the DescribeAccessPoints operation. 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.

Class DescribeAccessPointsResponse

This is the response object from the DescribeAccessPoints operation.

Class DescribeAccountPreferencesRequest

Container for the parameters to the DescribeAccountPreferences operation. 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.

Class DescribeAccountPreferencesResponse

This is the response object from the DescribeAccountPreferences operation.

Class DescribeBackupPolicyRequest

Container for the parameters to the DescribeBackupPolicy operation. Returns the backup policy for the specified EFS file system.

Class DescribeBackupPolicyResponse

This is the response object from the DescribeBackupPolicy operation.

Class DescribeFileSystemPolicyRequest

Container for the parameters to the DescribeFileSystemPolicy operation. Returns the FileSystemPolicy for the specified EFS file system.

This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.

Class DescribeFileSystemPolicyResponse

This is the response object from the DescribeFileSystemPolicy operation.

Class DescribeFileSystemsRequest

Container for the parameters to the DescribeFileSystems operation. 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. This number is automatically set to 100. 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.

Class DescribeFileSystemsResponse

This is the response object from the DescribeFileSystems operation.

Class DescribeLifecycleConfigurationRequest

Container for the parameters to the DescribeLifecycleConfiguration operation. Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. Lifecycle management uses the LifecycleConfiguration object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.

This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.

Class DescribeLifecycleConfigurationResponse

This is the response object from the DescribeLifecycleConfiguration operation.

Class DescribeMountTargetSecurityGroupsRequest

Container for the parameters to the DescribeMountTargetSecurityGroups operation. 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.

Class DescribeMountTargetSecurityGroupsResponse

This is the response object from the DescribeMountTargetSecurityGroups operation.

Class DescribeMountTargetsRequest

Container for the parameters to the DescribeMountTargets operation. 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.

Class DescribeMountTargetsResponse

Class DescribeReplicationConfigurationsRequest

Container for the parameters to the DescribeReplicationConfigurations operation. 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.

Class DescribeReplicationConfigurationsResponse

This is the response object from the DescribeReplicationConfigurations operation.

Class DescribeTagsRequest

Container for the parameters to the DescribeTags operation.

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.

Class DescribeTagsResponse

Class Destination

Describes the destination file system in the replication configuration.

Class DestinationToCreate

Describes the new or existing destination file system for the replication configuration.

  • If you want to replicate to a new file system, do not specify the File System ID for the destination file system. Amazon EFS creates a new, empty file system. For One Zone storage, specify the Availability Zone to create the file system in. To use an Key Management Service key other than the default KMS key, then specify it. For more information, see Configuring replication to new Amazon EFS file system in the Amazon EFS User Guide.

    After the file system is created, you cannot change the KMS key or the performance mode.

  • If you want to replicate to an existing file system that's in the same account as the source file system, then you need to provide the ID or Amazon Resource Name (ARN) of the file system to which to replicate. The file system's replication overwrite protection must be disabled. For more information, see Replicating to an existing file system in the Amazon EFS User Guide.

  • If you are replicating the file system to a file system that's in a different account than the source file system (cross-account replication), you need to provide the ARN for the file system and the IAM role that allows Amazon EFS to perform replication on the destination account. The file system's replication overwrite protection must be disabled. For more information, see Replicating across Amazon Web Services accounts in the Amazon EFS User Guide.

Class ElasticFileSystemPaginatorFactory

Paginators for the ElasticFileSystem service

Class FileSystemAlreadyExistsException

Returned if the file system you are trying to create already exists, with the creation token you provided.

Class FileSystemDescription

A description of the file system.

Class FileSystemInUseException

Returned if a file system has mount targets.

Class FileSystemLimitExceededException

Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.

Class FileSystemNotFoundException

Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

Class FileSystemProtectionDescription

Describes the protection on a file system.

Class FileSystemSize

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 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, the value represents the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.

Class IncorrectFileSystemLifeCycleStateException

Returned if the file system's lifecycle state is not "available".

Class IncorrectMountTargetStateException

Returned if the mount target is not in the correct state for the operation.

Class InsufficientThroughputCapacityException

Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.

Class InternalServerErrorException

Returned if an error occurred on the server side.

Class InvalidPolicyException

Returned if the FileSystemPolicy is malformed or contains an error such as a parameter value that is not valid or a missing required parameter. Returned in the case of a policy lockout safety check error.

Class IpAddressInUseException

Returned if the request specified an IpAddress that is already in use in the subnet.

Class LifecyclePolicy

Describes a policy used by lifecycle management that specifies when to transition files into and out of storage classes. For more information, see Managing file system storage.

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. For more information, see the request examples in PutLifecycleConfiguration.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. 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.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ModifyMountTargetSecurityGroupsRequest

Container for the parameters to the ModifyMountTargetSecurityGroups operation. 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.

Class ModifyMountTargetSecurityGroupsResponse

This is the response object from the ModifyMountTargetSecurityGroups operation.

Class MountTargetConflictException

Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.

Class MountTargetDescription

Provides a description of a mount target.

Class MountTargetNotFoundException

Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.

Class NetworkInterfaceLimitExceededException

The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. Either delete some network interfaces or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Network interfaces per Region entry in the Network interfaces table).

Class NoFreeAddressesInSubnetException

Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.

Class PolicyNotFoundException

Returned if the default file system policy is in effect for the EFS file system specified.

Class PosixUser

The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.

Class PutAccountPreferencesRequest

Container for the parameters to the PutAccountPreferences operation. 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.

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.

Class PutAccountPreferencesResponse

This is the response object from the PutAccountPreferences operation.

Class PutBackupPolicyRequest

Container for the parameters to the PutBackupPolicy operation. Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.

Class PutBackupPolicyResponse

This is the response object from the PutBackupPolicy operation.

Class PutFileSystemPolicyRequest

Container for the parameters to the PutFileSystemPolicy operation. 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.

EFS file system policies have a 20,000 character limit.

This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.

Class PutFileSystemPolicyResponse

This is the response object from the PutFileSystemPolicy operation.

Class PutLifecycleConfigurationRequest

Container for the parameters to the PutLifecycleConfiguration operation. Use this action to manage storage for your file system. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following:

  • TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

  • TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

    File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

    The Archive storage class is available only for file systems that use the Elastic throughput mode and the General Purpose performance mode.

  • TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

For more information, see Managing file system storage.

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. In the request, specify the following:

  • The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.

  • A LifecyclePolicies array of LifecyclePolicy objects that define when to move files to IA storage, to Archive storage, and back to primary storage.

    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.

Class PutLifecycleConfigurationResponse

This is the response object from the PutLifecycleConfiguration operation.

Class ReplicationAlreadyExistsException

Returned if the file system is already included in a replication configuration.>

Class ReplicationConfigurationDescription

Describes the replication configuration for a specific file system.

Class ReplicationNotFoundException

Returned if the specified file system does not have a replication configuration.

Class ResourceIdPreference

Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.

Class RootDirectory

Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's RootDirectory and its subdirectories.

Class SecurityGroupLimitExceededException

Returned if the size of SecurityGroups specified in the request is greater than five.

Class SecurityGroupNotFoundException

Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).

Class SubnetNotFoundException

Returned if there is no subnet with ID SubnetId provided in the request.

Class Tag

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: + - = . _ : /.

Class TagResourceRequest

Container for the parameters to the TagResource operation. 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.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class ThrottlingException

Returned when the CreateAccessPoint API action is called too quickly and the number of Access Points on the file system is nearing the limit of 120.

Class ThroughputLimitExceededException

Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.

Class TooManyRequestsException

Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.

Class UnsupportedAvailabilityZoneException

Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. 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.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateFileSystemProtectionRequest

Container for the parameters to the UpdateFileSystemProtection operation. Updates protection on the file system.

This operation requires permissions for the elasticfilesystem:UpdateFileSystemProtection action.

Class UpdateFileSystemProtectionResponse

Describes the protection on a file system.

Class UpdateFileSystemRequest

Container for the parameters to the UpdateFileSystem operation. Updates the throughput mode or the amount of provisioned throughput of an existing file system.

Class UpdateFileSystemResponse

A description of the file system.

Class ValidationException

Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.

Interfaces

NameDescription
Interface IDescribeAccessPointsPaginator

Paginator for the DescribeAccessPoints operation

Interface IDescribeFileSystemsPaginator

Paginator for the DescribeFileSystems operation

Interface IDescribeMountTargetsPaginator

Paginator for the DescribeMountTargets operation

Interface IDescribeReplicationConfigurationsPaginator

Paginator for the DescribeReplicationConfigurations operation

Interface IDescribeTagsPaginator

Paginator for the DescribeTags operation

Interface IElasticFileSystemPaginatorFactory

Paginators for the ElasticFileSystem service

Interface IListTagsForResourcePaginator

Paginator for the ListTagsForResource operation