PUT

/2015-02-01/file-systems/{FileSystemId}/lifecycle-configuration

http://elasticfilesystem.{region}.amazonaws.com/2015-02-01/file-systems/{FileSystemId}/lifecycle-configuration

Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A <code>LifecycleConfiguration</code> consists of one or more <code>LifecyclePolicy</code> objects that define the following: <ul> <li> EFS Lifecycle management - When Amazon EFS automatically transitions files in a file system into the lower-cost EFS Infrequent Access (IA) storage class. To enable EFS Lifecycle management, set the value of <code>TransitionToIA</code> to one of the available options. </li> <li> EFS Intelligent-Tiering - When Amazon EFS automatically transitions files from IA back into the file system's primary storage class (EFS Standard or EFS One Zone Standard). To enable EFS Intelligent-Tiering, set the value of <code>TransitionToPrimaryStorageClass</code> to <code>AFTER_1_ACCESS</code>. </li> </ul> For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">EFS Lifecycle Management</a>. Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a <code>LifecycleConfiguration</code> object already exists for the specified file system, a <code>PutLifecycleConfiguration</code> call modifies the existing configuration. A <code>PutLifecycleConfiguration</code> call with an empty <code>LifecyclePolicies</code> array in the request body deletes any existing <code>LifecycleConfiguration</code> and turns off lifecycle management and EFS Intelligent-Tiering for the file system. In the request, specify the following: <ul> <li> The ID for the file system for which you are enabling, disabling, or modifying lifecycle management and EFS Intelligent-Tiering. </li> <li> A <code>LifecyclePolicies</code> array of <code>LifecyclePolicy</code> objects that define when files are moved into IA storage, and when they are moved back to Standard storage. <note> Amazon EFS requires that each <code>LifecyclePolicy</code> object have only have a single transition, so the <code>LifecyclePolicies</code> array needs to be structured with separate <code>LifecyclePolicy</code> objects. See the example requests in the following section for more information. </note> </li> </ul> This operation requires permissions for the <code>elasticfilesystem:PutLifecycleConfiguration</code> operation. To apply a <code>LifecycleConfiguration</code> object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.

Access Token Required: API Key

Path Parameters

FileSystemIdstringrequired

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

Body Params

LifecyclePoliciesarrayrequired

An array of <code>LifecyclePolicy</code> objects that define the file system's <code>LifecycleConfiguration</code> object. A <code>LifecycleConfiguration</code> object informs EFS lifecycle management and EFS Intelligent-Tiering of the following: <ul> <li> When to move files in the file system from primary storage to the IA storage class. </li> <li> When to move files that are in IA storage to primary storage. </li> </ul> <note> When using the <code>put-lifecycle-configuration</code> CLI command or the <code>PutLifecycleConfiguration</code> API action, Amazon EFS requires that each <code>LifecyclePolicy</code> object have only a single transition. This means that in a request body, <code>LifecyclePolicies</code> must be structured as an array of <code>LifecyclePolicy</code> objects, one object for each transition, <code>TransitionToIA</code>, <code>TransitionToPrimaryStorageClass</code>. See the example requests in the following section for more information. </note>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://elasticfilesystem.{region}.amazonaws.com/2015-02-01/file-systems/{FileSystemId}/lifecycle-configuration' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request PUT \ 2 --url 'http://elasticfilesystem.{region}.amazonaws.com/2015-02-01/file-systems/{FileSystemId}/lifecycle-configuration' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'