efs.d.ts
  1  import {Request} from '../lib/request';
  2  import {Response} from '../lib/response';
  3  import {AWSError} from '../lib/error';
  4  import {Service} from '../lib/service';
  5  import {ServiceConfigurationOptions} from '../lib/service';
  6  import {ConfigBase as Config} from '../lib/config-base';
  7  interface Blob {}
  8  declare class EFS extends Service {
  9    /**
 10     * Constructs a service object. This object has one method for each API operation.
 11     */
 12    constructor(options?: EFS.Types.ClientConfiguration)
 13    config: Config & EFS.Types.ClientConfiguration;
 14    /**
 15     * 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 its own directory and below. To learn more, see Mounting a file system using EFS access points. This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
 16     */
 17    createAccessPoint(params: EFS.Types.CreateAccessPointRequest, callback?: (err: AWSError, data: EFS.Types.AccessPointDescription) => void): Request<EFS.Types.AccessPointDescription, AWSError>;
 18    /**
 19     * 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 its own directory and below. To learn more, see Mounting a file system using EFS access points. This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
 20     */
 21    createAccessPoint(callback?: (err: AWSError, data: EFS.Types.AccessPointDescription) => void): Request<EFS.Types.AccessPointDescription, AWSError>;
 22    /**
 23     * 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.  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 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. 
 24     */
 25    createFileSystem(params: EFS.Types.CreateFileSystemRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request<EFS.Types.FileSystemDescription, AWSError>;
 26    /**
 27     * 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.  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 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. 
 28     */
 29    createFileSystem(callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request<EFS.Types.FileSystemDescription, AWSError>;
 30    /**
 31     * 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:   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   
 32     */
 33    createMountTarget(params: EFS.Types.CreateMountTargetRequest, callback?: (err: AWSError, data: EFS.Types.MountTargetDescription) => void): Request<EFS.Types.MountTargetDescription, AWSError>;
 34    /**
 35     * 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:   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   
 36     */
 37    createMountTarget(callback?: (err: AWSError, data: EFS.Types.MountTargetDescription) => void): Request<EFS.Types.MountTargetDescription, AWSError>;
 38    /**
 39     *  DEPRECATED - CreateTags is deprecated and not maintained. Please use the API action to create tags for EFS resources.  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.
 40     */
 41    createTags(params: EFS.Types.CreateTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 42    /**
 43     *  DEPRECATED - CreateTags is deprecated and not maintained. Please use the API action to create tags for EFS resources.  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.
 44     */
 45    createTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 46    /**
 47     * 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.
 48     */
 49    deleteAccessPoint(params: EFS.Types.DeleteAccessPointRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 50    /**
 51     * 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.
 52     */
 53    deleteAccessPoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 54    /**
 55     * 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 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.
 56     */
 57    deleteFileSystem(params: EFS.Types.DeleteFileSystemRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 58    /**
 59     * 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 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.
 60     */
 61    deleteFileSystem(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 62    /**
 63     * 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.
 64     */
 65    deleteFileSystemPolicy(params: EFS.Types.DeleteFileSystemPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 66    /**
 67     * 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.
 68     */
 69    deleteFileSystemPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 70    /**
 71     * 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   
 72     */
 73    deleteMountTarget(params: EFS.Types.DeleteMountTargetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 74    /**
 75     * 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   
 76     */
 77    deleteMountTarget(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 78    /**
 79     *  DEPRECATED - DeleteTags is deprecated and not maintained. Please use the API action to remove tags from EFS resources.  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 AWS Billing and Cost Management User Guide. This operation requires permissions for the elasticfilesystem:DeleteTags action.
 80     */
 81    deleteTags(params: EFS.Types.DeleteTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 82    /**
 83     *  DEPRECATED - DeleteTags is deprecated and not maintained. Please use the API action to remove tags from EFS resources.  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 AWS Billing and Cost Management User Guide. This operation requires permissions for the elasticfilesystem:DeleteTags action.
 84     */
 85    deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
 86    /**
 87     * 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.
 88     */
 89    describeAccessPoints(params: EFS.Types.DescribeAccessPointsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeAccessPointsResponse) => void): Request<EFS.Types.DescribeAccessPointsResponse, AWSError>;
 90    /**
 91     * 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.
 92     */
 93    describeAccessPoints(callback?: (err: AWSError, data: EFS.Types.DescribeAccessPointsResponse) => void): Request<EFS.Types.DescribeAccessPointsResponse, AWSError>;
 94    /**
 95     * 
 96     */
 97    describeAccountPreferences(params: EFS.Types.DescribeAccountPreferencesRequest, callback?: (err: AWSError, data: EFS.Types.DescribeAccountPreferencesResponse) => void): Request<EFS.Types.DescribeAccountPreferencesResponse, AWSError>;
 98    /**
 99     * 
100     */
101    describeAccountPreferences(callback?: (err: AWSError, data: EFS.Types.DescribeAccountPreferencesResponse) => void): Request<EFS.Types.DescribeAccountPreferencesResponse, AWSError>;
102    /**
103     * Returns the backup policy for the specified EFS file system.
104     */
105    describeBackupPolicy(params: EFS.Types.DescribeBackupPolicyRequest, callback?: (err: AWSError, data: EFS.Types.BackupPolicyDescription) => void): Request<EFS.Types.BackupPolicyDescription, AWSError>;
106    /**
107     * Returns the backup policy for the specified EFS file system.
108     */
109    describeBackupPolicy(callback?: (err: AWSError, data: EFS.Types.BackupPolicyDescription) => void): Request<EFS.Types.BackupPolicyDescription, AWSError>;
110    /**
111     * Returns the FileSystemPolicy for the specified EFS file system. This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.
112     */
113    describeFileSystemPolicy(params: EFS.Types.DescribeFileSystemPolicyRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemPolicyDescription) => void): Request<EFS.Types.FileSystemPolicyDescription, AWSError>;
114    /**
115     * Returns the FileSystemPolicy for the specified EFS file system. This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.
116     */
117    describeFileSystemPolicy(callback?: (err: AWSError, data: EFS.Types.FileSystemPolicyDescription) => void): Request<EFS.Types.FileSystemPolicyDescription, AWSError>;
118    /**
119     * 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 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. 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. 
120     */
121    describeFileSystems(params: EFS.Types.DescribeFileSystemsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeFileSystemsResponse) => void): Request<EFS.Types.DescribeFileSystemsResponse, AWSError>;
122    /**
123     * 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 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. 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. 
124     */
125    describeFileSystems(callback?: (err: AWSError, data: EFS.Types.DescribeFileSystemsResponse) => void): Request<EFS.Types.DescribeFileSystemsResponse, AWSError>;
126    /**
127     * 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. This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.
128     */
129    describeLifecycleConfiguration(params: EFS.Types.DescribeLifecycleConfigurationRequest, callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
130    /**
131     * 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. This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.
132     */
133    describeLifecycleConfiguration(callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
134    /**
135     * 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.   
136     */
137    describeMountTargetSecurityGroups(params: EFS.Types.DescribeMountTargetSecurityGroupsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetSecurityGroupsResponse) => void): Request<EFS.Types.DescribeMountTargetSecurityGroupsResponse, AWSError>;
138    /**
139     * 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.   
140     */
141    describeMountTargetSecurityGroups(callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetSecurityGroupsResponse) => void): Request<EFS.Types.DescribeMountTargetSecurityGroupsResponse, AWSError>;
142    /**
143     * 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.
144     */
145    describeMountTargets(params: EFS.Types.DescribeMountTargetsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetsResponse) => void): Request<EFS.Types.DescribeMountTargetsResponse, AWSError>;
146    /**
147     * 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.
148     */
149    describeMountTargets(callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetsResponse) => void): Request<EFS.Types.DescribeMountTargetsResponse, AWSError>;
150    /**
151     *  DEPRECATED - The DeleteTags action is deprecated and not maintained. Please use the API action to remove tags from EFS resources.  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. 
152     */
153    describeTags(params: EFS.Types.DescribeTagsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeTagsResponse) => void): Request<EFS.Types.DescribeTagsResponse, AWSError>;
154    /**
155     *  DEPRECATED - The DeleteTags action is deprecated and not maintained. Please use the API action to remove tags from EFS resources.  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. 
156     */
157    describeTags(callback?: (err: AWSError, data: EFS.Types.DescribeTagsResponse) => void): Request<EFS.Types.DescribeTagsResponse, AWSError>;
158    /**
159     * 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.
160     */
161    listTagsForResource(params: EFS.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: EFS.Types.ListTagsForResourceResponse) => void): Request<EFS.Types.ListTagsForResourceResponse, AWSError>;
162    /**
163     * 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.
164     */
165    listTagsForResource(callback?: (err: AWSError, data: EFS.Types.ListTagsForResourceResponse) => void): Request<EFS.Types.ListTagsForResourceResponse, AWSError>;
166    /**
167     * 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.   
168     */
169    modifyMountTargetSecurityGroups(params: EFS.Types.ModifyMountTargetSecurityGroupsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
170    /**
171     * 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.   
172     */
173    modifyMountTargetSecurityGroups(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
174    /**
175     * 
176     */
177    putAccountPreferences(params: EFS.Types.PutAccountPreferencesRequest, callback?: (err: AWSError, data: EFS.Types.PutAccountPreferencesResponse) => void): Request<EFS.Types.PutAccountPreferencesResponse, AWSError>;
178    /**
179     * 
180     */
181    putAccountPreferences(callback?: (err: AWSError, data: EFS.Types.PutAccountPreferencesResponse) => void): Request<EFS.Types.PutAccountPreferencesResponse, AWSError>;
182    /**
183     * Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system. 
184     */
185    putBackupPolicy(params: EFS.Types.PutBackupPolicyRequest, callback?: (err: AWSError, data: EFS.Types.BackupPolicyDescription) => void): Request<EFS.Types.BackupPolicyDescription, AWSError>;
186    /**
187     * Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system. 
188     */
189    putBackupPolicy(callback?: (err: AWSError, data: EFS.Types.BackupPolicyDescription) => void): Request<EFS.Types.BackupPolicyDescription, AWSError>;
190    /**
191     * 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.
192     */
193    putFileSystemPolicy(params: EFS.Types.PutFileSystemPolicyRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemPolicyDescription) => void): Request<EFS.Types.FileSystemPolicyDescription, AWSError>;
194    /**
195     * 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.
196     */
197    putFileSystemPolicy(callback?: (err: AWSError, data: EFS.Types.FileSystemPolicyDescription) => void): Request<EFS.Types.FileSystemPolicyDescription, AWSError>;
198    /**
199     * Enables lifecycle management 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. 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 disables lifecycle management. 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 files are moved to the IA storage class. The array can contain only one LifecyclePolicy item.   This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation. To apply a LifecycleConfiguration object to an encrypted file system, you need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted file system. 
200     */
201    putLifecycleConfiguration(params: EFS.Types.PutLifecycleConfigurationRequest, callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
202    /**
203     * Enables lifecycle management 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. 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 disables lifecycle management. 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 files are moved to the IA storage class. The array can contain only one LifecyclePolicy item.   This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation. To apply a LifecycleConfiguration object to an encrypted file system, you need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted file system. 
204     */
205    putLifecycleConfiguration(callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
206    /**
207     * 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.
208     */
209    tagResource(params: EFS.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
210    /**
211     * 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.
212     */
213    tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
214    /**
215     * 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.
216     */
217    untagResource(params: EFS.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
218    /**
219     * 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.
220     */
221    untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
222    /**
223     * Updates the throughput mode or the amount of provisioned throughput of an existing file system.
224     */
225    updateFileSystem(params: EFS.Types.UpdateFileSystemRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request<EFS.Types.FileSystemDescription, AWSError>;
226    /**
227     * Updates the throughput mode or the amount of provisioned throughput of an existing file system.
228     */
229    updateFileSystem(callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request<EFS.Types.FileSystemDescription, AWSError>;
230  }
231  declare namespace EFS {
232    export type AccessPointArn = string;
233    export interface AccessPointDescription {
234      /**
235       * The opaque string specified in the request to ensure idempotent creation.
236       */
237      ClientToken?: ClientToken;
238      /**
239       * The name of the access point. This is the value of the Name tag.
240       */
241      Name?: Name;
242      /**
243       * The tags associated with the access point, presented as an array of Tag objects.
244       */
245      Tags?: Tags;
246      /**
247       * The ID of the access point, assigned by Amazon EFS.
248       */
249      AccessPointId?: AccessPointId;
250      /**
251       * The unique Amazon Resource Name (ARN) associated with the access point.
252       */
253      AccessPointArn?: AccessPointArn;
254      /**
255       * The ID of the EFS file system that the access point applies to.
256       */
257      FileSystemId?: FileSystemId;
258      /**
259       * 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.
260       */
261      PosixUser?: PosixUser;
262      /**
263       * The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
264       */
265      RootDirectory?: RootDirectory;
266      /**
267       * Identified the AWS account that owns the access point resource.
268       */
269      OwnerId?: AwsAccountId;
270      /**
271       * Identifies the lifecycle phase of the access point.
272       */
273      LifeCycleState?: LifeCycleState;
274    }
275    export type AccessPointDescriptions = AccessPointDescription[];
276    export type AccessPointId = string;
277    export type AvailabilityZoneId = string;
278    export type AvailabilityZoneName = string;
279    export type AwsAccountId = string;
280    export type Backup = boolean;
281    export interface BackupPolicy {
282      /**
283       * Describes the status of the file system's backup policy.     ENABLED  - EFS is automatically backing up the file system.     ENABLING  - EFS is turning on automatic backups for the file system.     DISABLED  - automatic back ups are turned off for the file system.     DISABLING  - EFS is turning off automatic backups for the file system.  
284       */
285      Status: Status;
286    }
287    export interface BackupPolicyDescription {
288      /**
289       * Describes the file system's backup policy, indicating whether automatic backups are turned on or off..
290       */
291      BackupPolicy?: BackupPolicy;
292    }
293    export type BypassPolicyLockoutSafetyCheck = boolean;
294    export type ClientToken = string;
295    export interface CreateAccessPointRequest {
296      /**
297       * A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
298       */
299      ClientToken: ClientToken;
300      /**
301       * Creates tags associated with the access point. Each tag is a key-value pair.
302       */
303      Tags?: Tags;
304      /**
305       * The ID of the EFS file system that the access point provides access to.
306       */
307      FileSystemId: FileSystemId;
308      /**
309       * The operating system user and group applied to all file system requests made using the access point.
310       */
311      PosixUser?: PosixUser;
312      /**
313       * 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 &gt; 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 need to 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.
314       */
315      RootDirectory?: RootDirectory;
316    }
317    export interface CreateFileSystemRequest {
318      /**
319       * A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
320       */
321      CreationToken: CreationToken;
322      /**
323       * 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.  The maxIO mode is not supported on file systems using One Zone storage classes. 
324       */
325      PerformanceMode?: PerformanceMode;
326      /**
327       * A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system. 
328       */
329      Encrypted?: Encrypted;
330      /**
331       * The ID of the AWS KMS CMK that you want to use to protect the encrypted file system. This parameter is only required if you want to use a non-default KMS key. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:   Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.   ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.   Key alias - A previously created display name for a key, for example alias/projectKey1.   Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.   If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true.  EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with EFS file systems. 
332       */
333      KmsKeyId?: KmsKeyId;
334      /**
335       * 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.
336       */
337      ThroughputMode?: ThroughputMode;
338      /**
339       * The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The upper limit for throughput is 1024 MiB/s. To increase this limit, contact AWS Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
340       */
341      ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps;
342      /**
343       * Used to create a file system that uses One Zone storage classes. It specifies the AWS 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.  One Zone storage classes are not available in all Availability Zones in AWS Regions where Amazon EFS is available. 
344       */
345      AvailabilityZoneName?: AvailabilityZoneName;
346      /**
347       * 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.  AWS Backup is not available in all AWS Regions where Amazon EFS is available. 
348       */
349      Backup?: Backup;
350      /**
351       * A value that specifies 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.
352       */
353      Tags?: Tags;
354    }
355    export interface CreateMountTargetRequest {
356      /**
357       * The ID of the file system for which to create the mount target.
358       */
359      FileSystemId: FileSystemId;
360      /**
361       * 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.
362       */
363      SubnetId: SubnetId;
364      /**
365       * Valid IPv4 address within the address range of the specified subnet.
366       */
367      IpAddress?: IpAddress;
368      /**
369       * Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified.
370       */
371      SecurityGroups?: SecurityGroups;
372    }
373    export interface CreateTagsRequest {
374      /**
375       * The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.
376       */
377      FileSystemId: FileSystemId;
378      /**
379       * An array of Tag objects to add. Each Tag object is a key-value pair. 
380       */
381      Tags: Tags;
382    }
383    export interface CreationInfo {
384      /**
385       * Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
386       */
387      OwnerUid: OwnerUid;
388      /**
389       * Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
390       */
391      OwnerGid: OwnerGid;
392      /**
393       * Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.
394       */
395      Permissions: Permissions;
396    }
397    export type CreationToken = string;
398    export interface DeleteAccessPointRequest {
399      /**
400       * The ID of the access point that you want to delete.
401       */
402      AccessPointId: AccessPointId;
403    }
404    export interface DeleteFileSystemPolicyRequest {
405      /**
406       * Specifies the EFS file system for which to delete the FileSystemPolicy.
407       */
408      FileSystemId: FileSystemId;
409    }
410    export interface DeleteFileSystemRequest {
411      /**
412       * The ID of the file system you want to delete.
413       */
414      FileSystemId: FileSystemId;
415    }
416    export interface DeleteMountTargetRequest {
417      /**
418       * The ID of the mount target to delete (String).
419       */
420      MountTargetId: MountTargetId;
421    }
422    export interface DeleteTagsRequest {
423      /**
424       * The ID of the file system whose tags you want to delete (String).
425       */
426      FileSystemId: FileSystemId;
427      /**
428       * A list of tag keys to delete.
429       */
430      TagKeys: TagKeys;
431    }
432    export interface DescribeAccessPointsRequest {
433      /**
434       * (Optional) When retrieving all access points for a file system, you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. The default value is 100. 
435       */
436      MaxResults?: MaxResults;
437      /**
438       *  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.
439       */
440      NextToken?: Token;
441      /**
442       * (Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.
443       */
444      AccessPointId?: AccessPointId;
445      /**
446       * (Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.
447       */
448      FileSystemId?: FileSystemId;
449    }
450    export interface DescribeAccessPointsResponse {
451      /**
452       * An array of access point descriptions.
453       */
454      AccessPoints?: AccessPointDescriptions;
455      /**
456       * 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.
457       */
458      NextToken?: Token;
459    }
460    export interface DescribeAccountPreferencesRequest {
461      NextToken?: Token;
462      MaxResults?: MaxResults;
463    }
464    export interface DescribeAccountPreferencesResponse {
465      ResourceIdPreference?: ResourceIdPreference;
466      NextToken?: Token;
467    }
468    export interface DescribeBackupPolicyRequest {
469      /**
470       * Specifies which EFS file system to retrieve the BackupPolicy for.
471       */
472      FileSystemId: FileSystemId;
473    }
474    export interface DescribeFileSystemPolicyRequest {
475      /**
476       * Specifies which EFS file system to retrieve the FileSystemPolicy for.
477       */
478      FileSystemId: FileSystemId;
479    }
480    export interface DescribeFileSystemsRequest {
481      /**
482       * (Optional) Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems. 
483       */
484      MaxItems?: MaxItems;
485      /**
486       * (Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If present, specifies to continue the list from where the returning call had left off. 
487       */
488      Marker?: Marker;
489      /**
490       * (Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.
491       */
492      CreationToken?: CreationToken;
493      /**
494       * (Optional) ID of the file system whose description you want to retrieve (String).
495       */
496      FileSystemId?: FileSystemId;
497    }
498    export interface DescribeFileSystemsResponse {
499      /**
500       * Present if provided by caller in the request (String).
501       */
502      Marker?: Marker;
503      /**
504       * An array of file system descriptions.
505       */
506      FileSystems?: FileSystemDescriptions;
507      /**
508       * 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.
509       */
510      NextMarker?: Marker;
511    }
512    export interface DescribeLifecycleConfigurationRequest {
513      /**
514       * The ID of the file system whose LifecycleConfiguration object you want to retrieve (String).
515       */
516      FileSystemId: FileSystemId;
517    }
518    export interface DescribeMountTargetSecurityGroupsRequest {
519      /**
520       * The ID of the mount target whose security groups you want to retrieve.
521       */
522      MountTargetId: MountTargetId;
523    }
524    export interface DescribeMountTargetSecurityGroupsResponse {
525      /**
526       * An array of security groups.
527       */
528      SecurityGroups: SecurityGroups;
529    }
530    export interface DescribeMountTargetsRequest {
531      /**
532       * (Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.
533       */
534      MaxItems?: MaxItems;
535      /**
536       * (Optional) Opaque pagination token returned from a previous DescribeMountTargets operation (String). If present, it specifies to continue the list from where the previous returning call left off.
537       */
538      Marker?: Marker;
539      /**
540       * (Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if an AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as input.
541       */
542      FileSystemId?: FileSystemId;
543      /**
544       * (Optional) ID of the mount target that you want to have described (String). It must be included in your request if FileSystemId is not included. Accepts either a mount target ID or ARN as input.
545       */
546      MountTargetId?: MountTargetId;
547      /**
548       * (Optional) The ID of the access point whose mount targets that you want to list. It must be included in your request if a FileSystemId or MountTargetId is not included in your request. Accepts either an access point ID or ARN as input.
549       */
550      AccessPointId?: AccessPointId;
551    }
552    export interface DescribeMountTargetsResponse {
553      /**
554       * If the request included the Marker, the response returns that value in this field.
555       */
556      Marker?: Marker;
557      /**
558       * Returns the file system's mount targets as an array of MountTargetDescription objects.
559       */
560      MountTargets?: MountTargetDescriptions;
561      /**
562       * 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.
563       */
564      NextMarker?: Marker;
565    }
566    export interface DescribeTagsRequest {
567      /**
568       * (Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.
569       */
570      MaxItems?: MaxItems;
571      /**
572       * (Optional) An opaque pagination token returned from a previous DescribeTags operation (String). If present, it specifies to continue the list from where the previous call left off.
573       */
574      Marker?: Marker;
575      /**
576       * The ID of the file system whose tag set you want to retrieve.
577       */
578      FileSystemId: FileSystemId;
579    }
580    export interface DescribeTagsResponse {
581      /**
582       * If the request included a Marker, the response returns that value in this field.
583       */
584      Marker?: Marker;
585      /**
586       * Returns tags associated with the file system as an array of Tag objects. 
587       */
588      Tags: Tags;
589      /**
590       * 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.
591       */
592      NextMarker?: Marker;
593    }
594    export type Encrypted = boolean;
595    export type FileSystemArn = string;
596    export interface FileSystemDescription {
597      /**
598       * 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.
599       */
600      OwnerId: AwsAccountId;
601      /**
602       * The opaque string specified in the request.
603       */
604      CreationToken: CreationToken;
605      /**
606       * The ID of the file system, assigned by Amazon EFS.
607       */
608      FileSystemId: FileSystemId;
609      /**
610       * 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 
611       */
612      FileSystemArn?: FileSystemArn;
613      /**
614       * The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
615       */
616      CreationTime: Timestamp;
617      /**
618       * The lifecycle phase of the file system.
619       */
620      LifeCycleState: LifeCycleState;
621      /**
622       * 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. 
623       */
624      Name?: TagValue;
625      /**
626       * The current number of mount targets that the file system has. For more information, see CreateMountTarget.
627       */
628      NumberOfMountTargets: MountTargetCount;
629      /**
630       * 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. 
631       */
632      SizeInBytes: FileSystemSize;
633      /**
634       * The performance mode of the file system.
635       */
636      PerformanceMode: PerformanceMode;
637      /**
638       * A Boolean value that, if true, indicates that the file system is encrypted.
639       */
640      Encrypted?: Encrypted;
641      /**
642       * The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
643       */
644      KmsKeyId?: KmsKeyId;
645      /**
646       * Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide. 
647       */
648      ThroughputMode?: ThroughputMode;
649      /**
650       * The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.
651       */
652      ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps;
653      /**
654       * Describes the AWS 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.
655       */
656      AvailabilityZoneName?: AvailabilityZoneName;
657      /**
658       * 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 AWS Region, and it has the same location in every AWS account.
659       */
660      AvailabilityZoneId?: AvailabilityZoneId;
661      /**
662       * The tags associated with the file system, presented as an array of Tag objects.
663       */
664      Tags: Tags;
665    }
666    export type FileSystemDescriptions = FileSystemDescription[];
667    export type FileSystemId = string;
668    export type FileSystemNullableSizeValue = number;
669    export interface FileSystemPolicyDescription {
670      /**
671       * Specifies the EFS file system to which the FileSystemPolicy applies.
672       */
673      FileSystemId?: FileSystemId;
674      /**
675       * The JSON formatted FileSystemPolicy for the EFS file system.
676       */
677      Policy?: Policy;
678    }
679    export interface FileSystemSize {
680      /**
681       * The latest known metered size (in bytes) of data stored in the file system.
682       */
683      Value: FileSystemSizeValue;
684      /**
685       * 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.
686       */
687      Timestamp?: Timestamp;
688      /**
689       * The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
690       */
691      ValueInIA?: FileSystemNullableSizeValue;
692      /**
693       * The latest known metered size (in bytes) of data stored in the Standard storage class.
694       */
695      ValueInStandard?: FileSystemNullableSizeValue;
696    }
697    export type FileSystemSizeValue = number;
698    export type Gid = number;
699    export type IpAddress = string;
700    export type KmsKeyId = string;
701    export type LifeCycleState = "creating"|"available"|"updating"|"deleting"|"deleted"|"error"|string;
702    export interface LifecycleConfigurationDescription {
703      /**
704       * An array of lifecycle management policies. Currently, EFS supports a maximum of one policy per file system.
705       */
706      LifecyclePolicies?: LifecyclePolicies;
707    }
708    export type LifecyclePolicies = LifecyclePolicy[];
709    export interface LifecyclePolicy {
710      /**
711       *  A value that describes the period of time that a file is not accessed, after which it transitions to the IA storage class. Metadata operations such as listing the contents of a directory don't count as file access events.
712       */
713      TransitionToIA?: TransitionToIARules;
714    }
715    export interface ListTagsForResourceRequest {
716      /**
717       * 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.
718       */
719      ResourceId: ResourceId;
720      /**
721       * (Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.
722       */
723      MaxResults?: MaxResults;
724      /**
725       * (Optional) You can use NextToken in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.
726       */
727      NextToken?: Token;
728    }
729    export interface ListTagsForResourceResponse {
730      /**
731       * An array of the tags for the specified EFS resource.
732       */
733      Tags?: Tags;
734      /**
735       *  NextToken is present if the response payload is paginated. You can use NextToken in a subsequent request to fetch the next page of access point descriptions.
736       */
737      NextToken?: Token;
738    }
739    export type Marker = string;
740    export type MaxItems = number;
741    export type MaxResults = number;
742    export interface ModifyMountTargetSecurityGroupsRequest {
743      /**
744       * The ID of the mount target whose security groups you want to modify.
745       */
746      MountTargetId: MountTargetId;
747      /**
748       * An array of up to five VPC security group IDs.
749       */
750      SecurityGroups?: SecurityGroups;
751    }
752    export type MountTargetCount = number;
753    export interface MountTargetDescription {
754      /**
755       * AWS account ID that owns the resource.
756       */
757      OwnerId?: AwsAccountId;
758      /**
759       * System-assigned mount target ID.
760       */
761      MountTargetId: MountTargetId;
762      /**
763       * The ID of the file system for which the mount target is intended.
764       */
765      FileSystemId: FileSystemId;
766      /**
767       * The ID of the mount target's subnet.
768       */
769      SubnetId: SubnetId;
770      /**
771       * Lifecycle state of the mount target.
772       */
773      LifeCycleState: LifeCycleState;
774      /**
775       * Address at which the file system can be mounted by using the mount target.
776       */
777      IpAddress?: IpAddress;
778      /**
779       * The ID of the network interface that Amazon EFS created when it created the mount target.
780       */
781      NetworkInterfaceId?: NetworkInterfaceId;
782      /**
783       * 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 AWS account.
784       */
785      AvailabilityZoneId?: AvailabilityZoneId;
786      /**
787       * The name of the Availability Zone in which the mount target is located. Availability Zones are independently mapped to names for each AWS account. For example, the Availability Zone us-east-1a for your AWS account might not be the same location as us-east-1a for another AWS account.
788       */
789      AvailabilityZoneName?: AvailabilityZoneName;
790      /**
791       * The virtual private cloud (VPC) ID that the mount target is configured in.
792       */
793      VpcId?: VpcId;
794    }
795    export type MountTargetDescriptions = MountTargetDescription[];
796    export type MountTargetId = string;
797    export type Name = string;
798    export type NetworkInterfaceId = string;
799    export type OwnerGid = number;
800    export type OwnerUid = number;
801    export type Path = string;
802    export type PerformanceMode = "generalPurpose"|"maxIO"|string;
803    export type Permissions = string;
804    export type Policy = string;
805    export interface PosixUser {
806      /**
807       * The POSIX user ID used for all file system operations using this access point.
808       */
809      Uid: Uid;
810      /**
811       * The POSIX group ID used for all file system operations using this access point.
812       */
813      Gid: Gid;
814      /**
815       * Secondary POSIX group IDs used for all file system operations using this access point.
816       */
817      SecondaryGids?: SecondaryGids;
818    }
819    export type ProvisionedThroughputInMibps = number;
820    export interface PutAccountPreferencesRequest {
821      ResourceIdType: ResourceIdType;
822    }
823    export interface PutAccountPreferencesResponse {
824      ResourceIdPreference?: ResourceIdPreference;
825    }
826    export interface PutBackupPolicyRequest {
827      /**
828       * Specifies which EFS file system to update the backup policy for.
829       */
830      FileSystemId: FileSystemId;
831      /**
832       * The backup policy included in the PutBackupPolicy request.
833       */
834      BackupPolicy: BackupPolicy;
835    }
836    export interface PutFileSystemPolicyRequest {
837      /**
838       * The ID of the EFS file system that you want to create or update the FileSystemPolicy for.
839       */
840      FileSystemId: FileSystemId;
841      /**
842       * 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. 
843       */
844      Policy: Policy;
845      /**
846       * (Optional) A flag to indicate whether to bypass the FileSystemPolicy lockout safety check. The policy lockout safety check determines whether the policy in the request will prevent the principal making the request will be locked out from making future PutFileSystemPolicy requests on the file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the principal that is making the request from making a subsequent PutFileSystemPolicy request on the file system. The default value is False. 
847       */
848      BypassPolicyLockoutSafetyCheck?: BypassPolicyLockoutSafetyCheck;
849    }
850    export interface PutLifecycleConfigurationRequest {
851      /**
852       * The ID of the file system for which you are creating the LifecycleConfiguration object (String).
853       */
854      FileSystemId: FileSystemId;
855      /**
856       * An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object tells lifecycle management when to transition files from the Standard storage class to the Infrequent Access storage class.
857       */
858      LifecyclePolicies: LifecyclePolicies;
859    }
860    export type Resource = "FILE_SYSTEM"|"MOUNT_TARGET"|string;
861    export type ResourceId = string;
862    export interface ResourceIdPreference {
863      ResourceIdType?: ResourceIdType;
864      Resources?: Resources;
865    }
866    export type ResourceIdType = "LONG_ID"|"SHORT_ID"|string;
867    export type Resources = Resource[];
868    export interface RootDirectory {
869      /**
870       * 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.
871       */
872      Path?: Path;
873      /**
874       * (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory &gt; 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.   If you do not provide CreationInfo and the specified RootDirectory &gt; Path does not exist, attempts to mount the file system using the access point will fail. 
875       */
876      CreationInfo?: CreationInfo;
877    }
878    export type SecondaryGids = Gid[];
879    export type SecurityGroup = string;
880    export type SecurityGroups = SecurityGroup[];
881    export type Status = "ENABLED"|"ENABLING"|"DISABLED"|"DISABLING"|string;
882    export type SubnetId = string;
883    export interface Tag {
884      /**
885       * The tag key (String). The key can't start with aws:.
886       */
887      Key: TagKey;
888      /**
889       * The value of the tag key.
890       */
891      Value: TagValue;
892    }
893    export type TagKey = string;
894    export type TagKeys = TagKey[];
895    export interface TagResourceRequest {
896      /**
897       * The ID specifying the EFS resource that you want to create a tag for.
898       */
899      ResourceId: ResourceId;
900      /**
901       * An array of Tag objects to add. Each Tag object is a key-value pair.
902       */
903      Tags: Tags;
904    }
905    export type TagValue = string;
906    export type Tags = Tag[];
907    export type ThroughputMode = "bursting"|"provisioned"|string;
908    export type Timestamp = Date;
909    export type Token = string;
910    export type TransitionToIARules = "AFTER_7_DAYS"|"AFTER_14_DAYS"|"AFTER_30_DAYS"|"AFTER_60_DAYS"|"AFTER_90_DAYS"|string;
911    export type Uid = number;
912    export interface UntagResourceRequest {
913      /**
914       * Specifies the EFS resource that you want to remove tags from.
915       */
916      ResourceId: ResourceId;
917      /**
918       * The keys of the key-value tag pairs that you want to remove from the specified EFS resource.
919       */
920      TagKeys: TagKeys;
921    }
922    export interface UpdateFileSystemRequest {
923      /**
924       * The ID of the file system that you want to update.
925       */
926      FileSystemId: FileSystemId;
927      /**
928       * (Optional) Updates the file system's throughput mode. If you're not updating your throughput mode, you don't need to provide this value in your request. If you are changing the ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps.
929       */
930      ThroughputMode?: ThroughputMode;
931      /**
932       * (Optional) Sets the amount of provisioned throughput, in MiB/s, for the file system. Valid values are 1-1024. If you are changing the throughput mode to provisioned, you must also provide the amount of provisioned throughput. Required if ThroughputMode is changed to provisioned on update.
933       */
934      ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps;
935    }
936    export type VpcId = string;
937    /**
938     * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
939     */
940    export type apiVersion = "2015-02-01"|"latest"|string;
941    export interface ClientApiVersions {
942      /**
943       * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
944       */
945      apiVersion?: apiVersion;
946    }
947    export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
948    /**
949     * Contains interfaces for use with the EFS client.
950     */
951    export import Types = EFS;
952  }
953  export = EFS;