v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1431160173.1 KB

Updates the throughput mode or the amount of provisioned throughput of an existing file system.

put/2015-02-01/file-systems/{FileSystemId}

Path parameters

FileSystemIdstring required

The ID of the file system that you want to update.

Request body

ThroughputMode'bursting' | 'provisioned' | 'elastic'

(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 <code>ThroughputMode</code> to <code>provisioned</code>, you must also set a value for <code>ProvisionedThroughputInMibps</code>.

ProvisionedThroughputInMibpsnumber double

(Optional) The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if <code>ThroughputMode</code> is set to <code>provisioned</code>. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Amazon Web Services Support. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits">Amazon EFS quotas that you can increase</a> in the <i>Amazon EFS User Guide</i>.

Response

Success

OwnerIdstring required

The Amazon Web Services account that created the file system.

CreationTokenstring required

The opaque string specified in the request.

FileSystemIdstring required

The ID of the file system, assigned by Amazon EFS.

FileSystemArnstring

The Amazon Resource Name (ARN) for the EFS file system, in the format <code>arn:aws:elasticfilesystem:<i>region</i>:<i>account-id</i>:file-system/<i>file-system-id</i> </code>. Example with sample data: <code>arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567</code>

CreationTimestring date-time required

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

LifeCycleState'creating' | 'available' | 'updating' | 'deleting' | 'deleted' | 'error' required

The lifecycle phase of the file system.

Namestring

You can add tags to a file system, including a <code>Name</code> tag. For more information, see <a>CreateFileSystem</a>. If the file system has a <code>Name</code> tag, Amazon EFS returns the value in this field.

NumberOfMountTargetsinteger required

The current number of mount targets that the file system has. For more information, see <a>CreateMountTarget</a>.

PerformanceMode'generalPurpose' | 'maxIO' required

The performance mode of the file system.

Encryptedboolean

A Boolean value that, if true, indicates that the file system is encrypted.

KmsKeyIdstring

The ID of an KMS key used to protect the encrypted file system.

ThroughputMode'bursting' | 'provisioned' | 'elastic'

Displays the file system's throughput mode. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes">Throughput modes</a> in the <i>Amazon EFS User Guide</i>.

ProvisionedThroughputInMibpsnumber double

The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using <code>ThroughputMode</code> set to <code>provisioned</code>.

AvailabilityZoneNamestring

Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">Using EFS storage classes</a> in the <i>Amazon EFS User Guide</i>.

AvailabilityZoneIdstring

The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example, <code>use1-az1</code> is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.