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.
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 also takes 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.
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.
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. For more information, see Amazon EFS: How it Works.
In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.
In the request, you also provide a subnet ID, which determines the following:
VPC in which Amazon EFS creates the mount target
Availability Zone in which Amazon EFS creates the mount target
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
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.
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.
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
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.
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.
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.
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.
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.
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.
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.
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.
You can enable lifecycle management only for EFS file systems created after the release of EFS infrequent access.
In the request, specify the following:
The ID for the file system for which you are creating a lifecycle management configuration.
A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved to the IA storage class. The array can contain only one \"TransitionToIA\": \"AFTER_30_DAYS\" 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.
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
" } }, "shapes":{ "AwsAccountId":{"type":"string"}, "BadRequest":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
", "error":{"httpStatusCode":400}, "exception":true }, "CreateFileSystemRequest":{ "type":"structure", "required":["CreationToken"], "members":{ "CreationToken":{ "shape":"CreationToken", "documentation":"A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
" }, "PerformanceMode":{ "shape":"PerformanceMode", "documentation":"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.
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.
The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. 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.
The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. 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.
" }, "ProvisionedThroughputInMibps":{ "shape":"ProvisionedThroughputInMibps", "documentation":"The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.
" }, "Tags":{ "shape":"Tags", "documentation":"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.
The ID of the file system for which to create the mount target.
" }, "SubnetId":{ "shape":"SubnetId", "documentation":"The ID of the subnet to add the mount target in.
" }, "IpAddress":{ "shape":"IpAddress", "documentation":"Valid IPv4 address within the address range of the specified subnet.
" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified.
The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.
", "location":"uri", "locationName":"FileSystemId" }, "Tags":{ "shape":"Tags", "documentation":"An array of Tag objects to add. Each Tag object is a key-value pair.
The ID of the file system you want to delete.
", "location":"uri", "locationName":"FileSystemId" } }, "documentation":"" }, "DeleteMountTargetRequest":{ "type":"structure", "required":["MountTargetId"], "members":{ "MountTargetId":{ "shape":"MountTargetId", "documentation":"The ID of the mount target to delete (String).
", "location":"uri", "locationName":"MountTargetId" } }, "documentation":"" }, "DeleteTagsRequest":{ "type":"structure", "required":[ "FileSystemId", "TagKeys" ], "members":{ "FileSystemId":{ "shape":"FileSystemId", "documentation":"The ID of the file system whose tags you want to delete (String).
", "location":"uri", "locationName":"FileSystemId" }, "TagKeys":{ "shape":"TagKeys", "documentation":"A list of tag keys to delete.
" } }, "documentation":"" }, "DependencyTimeout":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"The service timed out trying to fulfill the request, and the client should try the call again.
", "error":{"httpStatusCode":504}, "exception":true }, "DescribeFileSystemsRequest":{ "type":"structure", "members":{ "MaxItems":{ "shape":"MaxItems", "documentation":"(Optional) Specifies the maximum number of file systems to return in the response (integer). Currently, this number is automatically set to 10.
", "location":"querystring", "locationName":"MaxItems" }, "Marker":{ "shape":"Marker", "documentation":"(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.
(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.
", "location":"querystring", "locationName":"CreationToken" }, "FileSystemId":{ "shape":"FileSystemId", "documentation":"(Optional) ID of the file system whose description you want to retrieve (String).
", "location":"querystring", "locationName":"FileSystemId" } }, "documentation":"" }, "DescribeFileSystemsResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"Marker", "documentation":"Present if provided by caller in the request (String).
" }, "FileSystems":{ "shape":"FileSystemDescriptions", "documentation":"An array of file system descriptions.
" }, "NextMarker":{ "shape":"Marker", "documentation":"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.
The ID of the file system whose LifecycleConfiguration object you want to retrieve (String).
The ID of the mount target whose security groups you want to retrieve.
", "location":"uri", "locationName":"MountTargetId" } }, "documentation":"" }, "DescribeMountTargetSecurityGroupsResponse":{ "type":"structure", "required":["SecurityGroups"], "members":{ "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"An array of security groups.
" } } }, "DescribeMountTargetsRequest":{ "type":"structure", "members":{ "MaxItems":{ "shape":"MaxItems", "documentation":"(Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10.
", "location":"querystring", "locationName":"MaxItems" }, "Marker":{ "shape":"Marker", "documentation":"(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.
(Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if MountTargetId is not included.
(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.
If the request included the Marker, the response returns that value in this field.
Returns the file system's mount targets as an array of MountTargetDescription objects.
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.
(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 10.
", "location":"querystring", "locationName":"MaxItems" }, "Marker":{ "shape":"Marker", "documentation":"(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.
The ID of the file system whose tag set you want to retrieve.
", "location":"uri", "locationName":"FileSystemId" } }, "documentation":"" }, "DescribeTagsResponse":{ "type":"structure", "required":["Tags"], "members":{ "Marker":{ "shape":"Marker", "documentation":"If the request included a Marker, the response returns that value in this field.
Returns tags associated with the file system as an array of Tag objects.
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.
Returned if the file system you are trying to create already exists, with the creation token you provided.
", "error":{"httpStatusCode":409}, "exception":true }, "FileSystemDescription":{ "type":"structure", "required":[ "OwnerId", "CreationToken", "FileSystemId", "CreationTime", "LifeCycleState", "NumberOfMountTargets", "SizeInBytes", "PerformanceMode", "Tags" ], "members":{ "OwnerId":{ "shape":"AwsAccountId", "documentation":"The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
" }, "CreationToken":{ "shape":"CreationToken", "documentation":"The opaque string specified in the request.
" }, "FileSystemId":{ "shape":"FileSystemId", "documentation":"The ID of the file system, assigned by Amazon EFS.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
" }, "LifeCycleState":{ "shape":"LifeCycleState", "documentation":"The lifecycle phase of the file system.
" }, "Name":{ "shape":"TagValue", "documentation":"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.
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
" }, "SizeInBytes":{ "shape":"FileSystemSize", "documentation":"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.
The performance mode of the file system.
" }, "Encrypted":{ "shape":"Encrypted", "documentation":"A Boolean value that, if true, indicates that the file system is encrypted.
" }, "KmsKeyId":{ "shape":"KmsKeyId", "documentation":"The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
" }, "ThroughputMode":{ "shape":"ThroughputMode", "documentation":"The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. 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.
" }, "ProvisionedThroughputInMibps":{ "shape":"ProvisionedThroughputInMibps", "documentation":"The throughput, measured in MiB/s, that you want to provision for a file system. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.
" }, "Tags":{ "shape":"Tags", "documentation":"The tags associated with the file system, presented as an array of Tag objects.
A description of the file system.
" }, "FileSystemDescriptions":{ "type":"list", "member":{"shape":"FileSystemDescription"} }, "FileSystemId":{"type":"string"}, "FileSystemInUse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if a file system has mount targets.
", "error":{"httpStatusCode":409}, "exception":true }, "FileSystemLimitExceeded":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if the AWS account has already created the maximum number of file systems allowed per account.
", "error":{"httpStatusCode":403}, "exception":true }, "FileSystemNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
The latest known metered size (in bytes) of data stored in the file system.
" }, "Timestamp":{ "shape":"Timestamp", "documentation":"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.
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
" }, "ValueInStandard":{ "shape":"FileSystemNullableSizeValue", "documentation":"The latest known metered size (in bytes) of data stored in the Standard storage class.
" } }, "documentation":"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.
Returned if the file system's lifecycle state is not \"available\".
", "error":{"httpStatusCode":409}, "exception":true }, "IncorrectMountTargetState":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if the mount target is not in the correct state for the operation.
", "error":{"httpStatusCode":409}, "exception":true }, "InsufficientThroughputCapacity":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"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 to provisioned throughput mode.
", "error":{"httpStatusCode":503}, "exception":true }, "InternalServerError":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if an error occurred on the server side.
", "error":{"httpStatusCode":500}, "exception":true }, "IpAddress":{"type":"string"}, "IpAddressInUse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if the request specified an IpAddress that is already in use in the subnet.
An array of lifecycle management policies. Currently, EFS supports a maximum of one policy per file system.
" } } }, "LifecyclePolicies":{ "type":"list", "member":{"shape":"LifecyclePolicy"} }, "LifecyclePolicy":{ "type":"structure", "members":{ "TransitionToIA":{ "shape":"TransitionToIARules", "documentation":"A value that indicates how long it takes to transition files to the IA storage class. Currently, the only valid value is AFTER_30_DAYS.
AFTER_30_DAYS indicates files that have not been read from or written to for 30 days are transitioned from the Standard storage class to the IA storage class. Metadata operations such as listing the contents of a directory don't count as a file access event.
Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.
" }, "Marker":{"type":"string"}, "MaxItems":{ "type":"integer", "min":1 }, "ModifyMountTargetSecurityGroupsRequest":{ "type":"structure", "required":["MountTargetId"], "members":{ "MountTargetId":{ "shape":"MountTargetId", "documentation":"The ID of the mount target whose security groups you want to modify.
", "location":"uri", "locationName":"MountTargetId" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"An array of up to five VPC security group IDs.
" } }, "documentation":"" }, "MountTargetConflict":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.
", "error":{"httpStatusCode":409}, "exception":true }, "MountTargetCount":{ "type":"integer", "min":0 }, "MountTargetDescription":{ "type":"structure", "required":[ "MountTargetId", "FileSystemId", "SubnetId", "LifeCycleState" ], "members":{ "OwnerId":{ "shape":"AwsAccountId", "documentation":"AWS account ID that owns the resource.
" }, "MountTargetId":{ "shape":"MountTargetId", "documentation":"System-assigned mount target ID.
" }, "FileSystemId":{ "shape":"FileSystemId", "documentation":"The ID of the file system for which the mount target is intended.
" }, "SubnetId":{ "shape":"SubnetId", "documentation":"The ID of the mount target's subnet.
" }, "LifeCycleState":{ "shape":"LifeCycleState", "documentation":"Lifecycle state of the mount target.
" }, "IpAddress":{ "shape":"IpAddress", "documentation":"Address at which the file system can be mounted by using the mount target.
" }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"The ID of the network interface that Amazon EFS created when it created the mount target.
" } }, "documentation":"Provides a description of a mount target.
" }, "MountTargetDescriptions":{ "type":"list", "member":{"shape":"MountTargetDescription"} }, "MountTargetId":{"type":"string"}, "MountTargetNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if there is no mount target with the specified ID found in the caller's account.
", "error":{"httpStatusCode":404}, "exception":true }, "NetworkInterfaceId":{"type":"string"}, "NetworkInterfaceLimitExceeded":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"The calling account has reached the limit for elastic network interfaces for the specific AWS Region. The client should try to delete some elastic network interfaces or get the account limit raised. For more information, see Amazon VPC Limits in the Amazon VPC User Guide (see the Network interfaces per VPC entry in the table).
", "error":{"httpStatusCode":409}, "exception":true }, "NoFreeAddressesInSubnet":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.
The ID of the file system for which you are creating the LifecycleConfiguration object (String).
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.
Returned if the size of SecurityGroups specified in the request is greater than five.
Returned if one of the specified security groups doesn't exist in the subnet's VPC.
", "error":{"httpStatusCode":400}, "exception":true }, "SecurityGroups":{ "type":"list", "member":{"shape":"SecurityGroup"}, "max":5 }, "SubnetId":{"type":"string"}, "SubnetNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if there is no subnet with ID SubnetId provided in the request.
The tag key (String). The key can't start with aws:.
The value of the tag key.
" } }, "documentation":"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: + - = . _ : /
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.
", "error":{"httpStatusCode":400}, "exception":true }, "ThroughputMode":{ "type":"string", "enum":[ "bursting", "provisioned" ] }, "Timestamp":{"type":"timestamp"}, "TooManyRequests":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"Returned if you don’t wait at least 24 hours before changing the throughput mode, or decreasing the Provisioned Throughput value.
", "error":{"httpStatusCode":429}, "exception":true }, "TransitionToIARules":{ "type":"string", "enum":["AFTER_30_DAYS"] }, "UnsupportedAvailabilityZone":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"", "error":{"httpStatusCode":400}, "exception":true }, "UpdateFileSystemRequest":{ "type":"structure", "required":["FileSystemId"], "members":{ "FileSystemId":{ "shape":"FileSystemId", "documentation":"The ID of the file system that you want to update.
", "location":"uri", "locationName":"FileSystemId" }, "ThroughputMode":{ "shape":"ThroughputMode", "documentation":"(Optional) The throughput mode that you want your file system to use. If you're not updating your throughput mode, you don't need to provide this value in your request.
" }, "ProvisionedThroughputInMibps":{ "shape":"ProvisionedThroughputInMibps", "documentation":"(Optional) The amount of throughput, in MiB/s, that you want to provision for your file system. If you're not updating the amount of provisioned throughput for your file system, you don't need to provide this value in your request.
" } } } }, "documentation":"Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the User Guide.
" }