Amazon Elastic File System

2022/11/28 - Amazon Elastic File System - 5 updated api methods

Changes  Update efs client to latest version

CreateFileSystem (updated) Link ¶
Changes (both)
{'ThroughputMode': {'elastic'}}

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following:

  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

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.

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.

See also: AWS API Documentation

Request Syntax

client.create_file_system(
    CreationToken='string',
    PerformanceMode='generalPurpose'|'maxIO',
    Encrypted=True|False,
    KmsKeyId='string',
    ThroughputMode='bursting'|'provisioned'|'elastic',
    ProvisionedThroughputInMibps=123.0,
    AvailabilityZoneName='string',
    Backup=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type CreationToken:

string

param CreationToken:

[REQUIRED]

A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

This field is autopopulated if not provided.

type PerformanceMode:

string

param PerformanceMode:

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.

type Encrypted:

boolean

param Encrypted:

A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying an existing Key Management Service key (KMS key). If you don't specify a KMS key, then the default KMS key for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.

type KmsKeyId:

string

param KmsKeyId:

The ID of the KMS key that you want to use to protect the encrypted file system. This parameter is required only if you want to use a non-default KMS key. If this parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a KMS key ID using 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 you use KmsKeyId, you must set the CreateFileSystemRequest$Encrypted parameter to true.

type ThroughputMode:

string

param ThroughputMode:

Specifies the throughput mode for the file system. The mode can be bursting, provisioned, or elastic. 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, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide.

Default is bursting.

type ProvisionedThroughputInMibps:

float

param ProvisionedThroughputInMibps:

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 Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.

type AvailabilityZoneName:

string

param AvailabilityZoneName:

Used to create a file system that uses One Zone storage classes. It specifies the Amazon Web Services 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.

type Backup:

boolean

param Backup:

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.

type Tags:

list

param Tags:

Use 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. Each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

  • (dict) --

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

    • Key (string) -- [REQUIRED]

      The tag key (String). The key can't start with aws:.

    • Value (string) -- [REQUIRED]

      The value of the tag key.

rtype:

dict

returns:

Response Syntax

{
    'OwnerId': 'string',
    'CreationToken': 'string',
    'FileSystemId': 'string',
    'FileSystemArn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
    'Name': 'string',
    'NumberOfMountTargets': 123,
    'SizeInBytes': {
        'Value': 123,
        'Timestamp': datetime(2015, 1, 1),
        'ValueInIA': 123,
        'ValueInStandard': 123
    },
    'PerformanceMode': 'generalPurpose'|'maxIO',
    'Encrypted': True|False,
    'KmsKeyId': 'string',
    'ThroughputMode': 'bursting'|'provisioned'|'elastic',
    'ProvisionedThroughputInMibps': 123.0,
    'AvailabilityZoneName': 'string',
    'AvailabilityZoneId': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    A description of the file system.

    • OwnerId (string) --

      The Amazon Web Services 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 (string) --

      The opaque string specified in the request.

    • FileSystemId (string) --

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

    • FileSystemArn (string) --

      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

    • CreationTime (datetime) --

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

    • LifeCycleState (string) --

      The lifecycle phase of the file system.

    • Name (string) --

      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.

    • NumberOfMountTargets (integer) --

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

    • SizeInBytes (dict) --

      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.

      • Value (integer) --

        The latest known metered size (in bytes) of data stored in the file system.

      • Timestamp (datetime) --

        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.

      • ValueInIA (integer) --

        The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.

      • ValueInStandard (integer) --

        The latest known metered size (in bytes) of data stored in the Standard storage class.

    • PerformanceMode (string) --

      The performance mode of the file system.

    • Encrypted (boolean) --

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

    • KmsKeyId (string) --

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

    • ThroughputMode (string) --

      Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

    • ProvisionedThroughputInMibps (float) --

      The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.

    • AvailabilityZoneName (string) --

      Describes the Amazon Web Services 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.

    • AvailabilityZoneId (string) --

      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 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

    • Tags (list) --

      The tags associated with the file system, presented as an array of Tag objects.

      • (dict) --

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

        • Key (string) --

          The tag key (String). The key can't start with aws:.

        • Value (string) --

          The value of the tag key.

DescribeFileSystems (updated) Link ¶
Changes (response)
{'FileSystems': {'ThroughputMode': {'elastic'}}}

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. 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.

See also: AWS API Documentation

Request Syntax

client.describe_file_systems(
    MaxItems=123,
    Marker='string',
    CreationToken='string',
    FileSystemId='string'
)
type MaxItems:

integer

param MaxItems:

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

type Marker:

string

param Marker:

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

type CreationToken:

string

param CreationToken:

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

type FileSystemId:

string

param FileSystemId:

(Optional) ID of the file system whose description you want to retrieve (String).

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'FileSystems': [
        {
            'OwnerId': 'string',
            'CreationToken': 'string',
            'FileSystemId': 'string',
            'FileSystemArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
            'Name': 'string',
            'NumberOfMountTargets': 123,
            'SizeInBytes': {
                'Value': 123,
                'Timestamp': datetime(2015, 1, 1),
                'ValueInIA': 123,
                'ValueInStandard': 123
            },
            'PerformanceMode': 'generalPurpose'|'maxIO',
            'Encrypted': True|False,
            'KmsKeyId': 'string',
            'ThroughputMode': 'bursting'|'provisioned'|'elastic',
            'ProvisionedThroughputInMibps': 123.0,
            'AvailabilityZoneName': 'string',
            'AvailabilityZoneId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextMarker': 'string'
}

Response Structure

  • (dict) --

    • Marker (string) --

      Present if provided by caller in the request (String).

    • FileSystems (list) --

      An array of file system descriptions.

      • (dict) --

        A description of the file system.

        • OwnerId (string) --

          The Amazon Web Services 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 (string) --

          The opaque string specified in the request.

        • FileSystemId (string) --

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

        • FileSystemArn (string) --

          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

        • CreationTime (datetime) --

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

        • LifeCycleState (string) --

          The lifecycle phase of the file system.

        • Name (string) --

          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.

        • NumberOfMountTargets (integer) --

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

        • SizeInBytes (dict) --

          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.

          • Value (integer) --

            The latest known metered size (in bytes) of data stored in the file system.

          • Timestamp (datetime) --

            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.

          • ValueInIA (integer) --

            The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.

          • ValueInStandard (integer) --

            The latest known metered size (in bytes) of data stored in the Standard storage class.

        • PerformanceMode (string) --

          The performance mode of the file system.

        • Encrypted (boolean) --

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

        • KmsKeyId (string) --

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

        • ThroughputMode (string) --

          Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

        • ProvisionedThroughputInMibps (float) --

          The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.

        • AvailabilityZoneName (string) --

          Describes the Amazon Web Services 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.

        • AvailabilityZoneId (string) --

          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 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

        • Tags (list) --

          The tags associated with the file system, presented as an array of Tag objects.

          • (dict) --

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

            • Key (string) --

              The tag key (String). The key can't start with aws:.

            • Value (string) --

              The value of the tag key.

    • NextMarker (string) --

      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.

DescribeLifecycleConfiguration (updated) Link ¶
Changes (response)
{'LifecyclePolicies': {'TransitionToIA': {'AFTER_1_DAY'}}}

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.

When EFS Intelligent-Tiering is enabled, TransitionToPrimaryStorageClass has a value of AFTER_1_ACCESS.

This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.

See also: AWS API Documentation

Request Syntax

client.describe_lifecycle_configuration(
    FileSystemId='string'
)
type FileSystemId:

string

param FileSystemId:

[REQUIRED]

The ID of the file system whose LifecycleConfiguration object you want to retrieve (String).

rtype:

dict

returns:

Response Syntax

{
    'LifecyclePolicies': [
        {
            'TransitionToIA': 'AFTER_7_DAYS'|'AFTER_14_DAYS'|'AFTER_30_DAYS'|'AFTER_60_DAYS'|'AFTER_90_DAYS'|'AFTER_1_DAY',
            'TransitionToPrimaryStorageClass': 'AFTER_1_ACCESS'
        },
    ]
}

Response Structure

  • (dict) --

    • LifecyclePolicies (list) --

      An array of lifecycle management policies. EFS supports a maximum of one policy per file system.

      • (dict) --

        Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle Management.

        • TransitionToIA (string) --

          Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.

        • TransitionToPrimaryStorageClass (string) --

          Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.

PutLifecycleConfiguration (updated) Link ¶
Changes (both)
{'LifecyclePolicies': {'TransitionToIA': {'AFTER_1_DAY'}}}

Use this action to manage EFS lifecycle management and intelligent tiering. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following:

  • EFS Lifecycle management - When Amazon EFS automatically transitions files in a file system into the lower-cost Infrequent Access (IA) storage class. To enable EFS Lifecycle management, set the value of TransitionToIA to one of the available options.

  • EFS Intelligent tiering - When Amazon EFS automatically transitions files from IA back into the file system's primary storage class (Standard or One Zone Standard. To enable EFS Intelligent Tiering, set the value of TransitionToPrimaryStorageClass to AFTER_1_ACCESS.

For more information, see EFS Lifecycle Management.

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 turns off lifecycle management and intelligent tiering for the file system.

In the request, specify the following:

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

  • A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved into IA storage, and when they are moved back to Standard storage.

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.

See also: AWS API Documentation

Request Syntax

client.put_lifecycle_configuration(
    FileSystemId='string',
    LifecyclePolicies=[
        {
            'TransitionToIA': 'AFTER_7_DAYS'|'AFTER_14_DAYS'|'AFTER_30_DAYS'|'AFTER_60_DAYS'|'AFTER_90_DAYS'|'AFTER_1_DAY',
            'TransitionToPrimaryStorageClass': 'AFTER_1_ACCESS'
        },
    ]
)
type FileSystemId:

string

param FileSystemId:

[REQUIRED]

The ID of the file system for which you are creating the LifecycleConfiguration object (String).

type LifecyclePolicies:

list

param LifecyclePolicies:

[REQUIRED]

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS lifecycle management and EFS Intelligent-Tiering of the following:

  • When to move files in the file system from primary storage to the IA storage class.

  • When to move files that are in IA storage to primary storage.

  • (dict) --

    Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle Management.

    • TransitionToIA (string) --

      Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.

    • TransitionToPrimaryStorageClass (string) --

      Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.

rtype:

dict

returns:

Response Syntax

{
    'LifecyclePolicies': [
        {
            'TransitionToIA': 'AFTER_7_DAYS'|'AFTER_14_DAYS'|'AFTER_30_DAYS'|'AFTER_60_DAYS'|'AFTER_90_DAYS'|'AFTER_1_DAY',
            'TransitionToPrimaryStorageClass': 'AFTER_1_ACCESS'
        },
    ]
}

Response Structure

  • (dict) --

    • LifecyclePolicies (list) --

      An array of lifecycle management policies. EFS supports a maximum of one policy per file system.

      • (dict) --

        Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle Management.

        • TransitionToIA (string) --

          Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.

        • TransitionToPrimaryStorageClass (string) --

          Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.

UpdateFileSystem (updated) Link ¶
Changes (both)
{'ThroughputMode': {'elastic'}}

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

See also: AWS API Documentation

Request Syntax

client.update_file_system(
    FileSystemId='string',
    ThroughputMode='bursting'|'provisioned'|'elastic',
    ProvisionedThroughputInMibps=123.0
)
type FileSystemId:

string

param FileSystemId:

[REQUIRED]

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

type ThroughputMode:

string

param ThroughputMode:

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

type ProvisionedThroughputInMibps:

float

param ProvisionedThroughputInMibps:

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

rtype:

dict

returns:

Response Syntax

{
    'OwnerId': 'string',
    'CreationToken': 'string',
    'FileSystemId': 'string',
    'FileSystemArn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
    'Name': 'string',
    'NumberOfMountTargets': 123,
    'SizeInBytes': {
        'Value': 123,
        'Timestamp': datetime(2015, 1, 1),
        'ValueInIA': 123,
        'ValueInStandard': 123
    },
    'PerformanceMode': 'generalPurpose'|'maxIO',
    'Encrypted': True|False,
    'KmsKeyId': 'string',
    'ThroughputMode': 'bursting'|'provisioned'|'elastic',
    'ProvisionedThroughputInMibps': 123.0,
    'AvailabilityZoneName': 'string',
    'AvailabilityZoneId': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    A description of the file system.

    • OwnerId (string) --

      The Amazon Web Services 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 (string) --

      The opaque string specified in the request.

    • FileSystemId (string) --

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

    • FileSystemArn (string) --

      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

    • CreationTime (datetime) --

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

    • LifeCycleState (string) --

      The lifecycle phase of the file system.

    • Name (string) --

      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.

    • NumberOfMountTargets (integer) --

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

    • SizeInBytes (dict) --

      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.

      • Value (integer) --

        The latest known metered size (in bytes) of data stored in the file system.

      • Timestamp (datetime) --

        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.

      • ValueInIA (integer) --

        The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.

      • ValueInStandard (integer) --

        The latest known metered size (in bytes) of data stored in the Standard storage class.

    • PerformanceMode (string) --

      The performance mode of the file system.

    • Encrypted (boolean) --

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

    • KmsKeyId (string) --

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

    • ThroughputMode (string) --

      Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

    • ProvisionedThroughputInMibps (float) --

      The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.

    • AvailabilityZoneName (string) --

      Describes the Amazon Web Services 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.

    • AvailabilityZoneId (string) --

      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 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

    • Tags (list) --

      The tags associated with the file system, presented as an array of Tag objects.

      • (dict) --

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

        • Key (string) --

          The tag key (String). The key can't start with aws:.

        • Value (string) --

          The value of the tag key.