Amazon Elastic File System

{'LifecyclePolicies': {'TransitionToIA': {'AFTER_14_DAYS',
                                          'AFTER_60_DAYS',
                                          'AFTER_90_DAYS'}}}

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.

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_14_DAYS'|'AFTER_30_DAYS'|'AFTER_60_DAYS'|'AFTER_90_DAYS'
        },
    ]
}

Response Structure

• (dict) --

  • LifecyclePolicies (list) --

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

    • (dict) --

      Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

      • TransitionToIA (string) --

        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.

{'LifecyclePolicies': {'TransitionToIA': {'AFTER_14_DAYS',
                                          'AFTER_60_DAYS',
                                          'AFTER_90_DAYS'}}}

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.

See also: AWS API Documentation

Request Syntax

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

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 tells lifecycle management when to transition files from the Standard storage class to the Infrequent Access storage class.

• (dict) --

  Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

  • TransitionToIA (string) --

    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.

rtype:

dict

returns:

Response Syntax

{
    'LifecyclePolicies': [
        {
            'TransitionToIA': 'AFTER_14_DAYS'|'AFTER_30_DAYS'|'AFTER_60_DAYS'|'AFTER_90_DAYS'
        },
    ]
}

Response Structure

• (dict) --

  • LifecyclePolicies (list) --

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

    • (dict) --

      Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

      • TransitionToIA (string) --

        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.